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 customer master key (CMK).
ConnectCustomKeyStore ( array $params = [] )
Connects or reconnects a custom key store to its associated AWS CloudHSM cluster.
CreateAlias ( array $params = [] )
Creates a display name for a customer managed customer master key (CMK).
CreateCustomKeyStore ( array $params = [] )
Creates a custom key store that is associated with an AWS CloudHSM cluster that you own and manage.
CreateGrant ( array $params = [] )
Adds a grant to a customer master key (CMK).
CreateKey ( array $params = [] )
Creates a unique customer managed customer master key (CMK) in your AWS account and Region.
Decrypt ( array $params = [] )
Decrypts ciphertext that was encrypted by a AWS KMS customer master key (CMK) 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 or asymmetric CMK.
DeleteAlias ( array $params = [] )
Deletes the specified alias.
DeleteCustomKeyStore ( array $params = [] )
Deletes a custom key store.
DeleteImportedKeyMaterial ( array $params = [] )
Deletes key material that you previously imported.
DescribeCustomKeyStores ( array $params = [] )
Gets information about custom key stores in the account and region.
DescribeKey ( array $params = [] )
Provides detailed information about a customer master key (CMK).
DisableKey ( array $params = [] )
Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic operations.
DisableKeyRotation ( array $params = [] )
Disables automatic rotation of the key material for the specified symmetric customer master key (CMK).
DisconnectCustomKeyStore ( array $params = [] )
Disconnects the custom key store from its associated AWS CloudHSM cluster.
EnableKey ( array $params = [] )
Sets the key state of a customer master key (CMK) to enabled.
EnableKeyRotation ( array $params = [] )
Enables automatic rotation of the key material for the specified symmetric customer master key (CMK).
Encrypt ( array $params = [] )
Encrypts plaintext into ciphertext by using a customer master key (CMK).
GenerateDataKey ( array $params = [] )
Generates a unique symmetric data key.
GenerateDataKeyPair ( array $params = [] )
Generates a unique asymmetric data key pair.
GenerateDataKeyPairWithoutPlaintext ( array $params = [] )
Generates a unique asymmetric data key pair.
GenerateDataKeyWithoutPlaintext ( array $params = [] )
Generates a unique symmetric data key.
GenerateRandom ( array $params = [] )
Returns a random byte string that is cryptographically secure.
GetKeyPolicy ( array $params = [] )
Gets a key policy attached to the specified customer master key (CMK).
GetKeyRotationStatus ( array $params = [] )
Gets a Boolean value that indicates whether automatic rotation of the key material is enabled for the specified customer master key (CMK).
GetParametersForImport ( array $params = [] )
Returns the items you need to import key material into a symmetric, customer managed customer master key (CMK).
GetPublicKey ( array $params = [] )
Returns the public key of an asymmetric CMK.
ImportKeyMaterial ( array $params = [] )
Imports key material into an existing symmetric AWS KMS customer master key (CMK) that was created without key material.
ListAliases ( array $params = [] )
Gets a list of aliases in the caller's AWS account and region.
ListGrants ( array $params = [] )
Gets a list of all grants for the specified customer master key (CMK).
ListKeyPolicies ( array $params = [] )
Gets the names of the key policies that are attached to a customer master key (CMK).
ListKeys ( array $params = [] )
Gets a list of all customer master keys (CMKs) in the caller's AWS account and Region.
ListResourceTags ( array $params = [] )
Returns a list of all tags for the specified customer master key (CMK).
ListRetirableGrants ( array $params = [] )
Returns a list of all grants for which the grant's RetiringPrincipal matches the one specified.
PutKeyPolicy ( array $params = [] )
Attaches a key policy to the specified customer master key (CMK).
ReEncrypt ( array $params = [] )
Decrypts ciphertext and then reencrypts it entirely within AWS KMS.
RetireGrant ( array $params = [] )
Retires a grant.
RevokeGrant ( array $params = [] )
Revokes the specified grant for the specified customer master key (CMK).
ScheduleKeyDeletion ( array $params = [] )
Schedules the deletion of a customer master key (CMK).
Sign ( array $params = [] )
Creates a digital signature for a message or message digest by using the private key in an asymmetric CMK.
TagResource ( array $params = [] )
Adds or edits tags for a customer master key (CMK).
UntagResource ( array $params = [] )
Removes the specified tags from the specified customer master key (CMK).
UpdateAlias ( array $params = [] )
Associates an existing AWS KMS alias with a different customer master key (CMK).
UpdateCustomKeyStore ( array $params = [] )
Changes the properties of a custom key store.
UpdateKeyDescription ( array $params = [] )
Updates the description of a customer master key (CMK).
Verify ( array $params = [] )
Verifies a digital signature that was generated by the Sign operation.

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:

ListAliases
ListGrants
ListKeyPolicies
ListKeys

Operations

CancelKeyDeletion

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

Cancels the deletion of a customer master key (CMK). When this operation succeeds, the key state of the CMK is Disabled. To enable the CMK, use EnableKey. You cannot perform this operation on a CMK in a different AWS account.

For more information about scheduling and canceling deletion of a CMK, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Parameter Syntax

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

Parameter Details

Members

KeyId

Required: Yes
Type: string

The unique identifier for the customer master key (CMK) for which to cancel deletion.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

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 CMK, use ListKeys or DescribeKey.

Result Syntax

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

Result Details

Members

KeyId

Type: string

The unique identifier of the master key for which 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. The request can be retried.
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.

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

Examples

Example 1: To cancel deletion of a customer master key (CMK)

The following example cancels deletion of the specified CMK.

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

Result syntax:

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

ConnectCustomKeyStore

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

Connects or reconnects a custom key store to its associated AWS CloudHSM cluster.

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

To connect a custom key store, its associated AWS 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 AWS KMS from using this account to log in.

The connection process can take an extended amount of time to complete; up to 20 minutes. 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.

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

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.

If you are having trouble connecting or disconnecting a custom key store, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.

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 AWS CloudHSM cluster that is associated with the custom key store is not active. Initialize and activate the cluster and try the command again. For detailed instructions, see Getting Started in the AWS 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 CreateKey or GenerateRandom operation in a custom key store that is not connected. These operations are valid only when the custom key store ConnectionState is CONNECTED.
- 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 ConnectCustomKeyStore operation on a custom key store with a ConnectionState of DISCONNECTING or FAILED. This operation is valid for all other ConnectionState values.
CustomKeyStoreNotFoundException:
The request was rejected because AWS 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 AWS CloudHSM cluster did not meet the configuration requirements for a custom key store.
- The 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 cluster. Do not delete or change them. To get information about a particular security group, use the DescribeSecurityGroups operation.
- The cluster must contain at least as many HSMs as the operation requires. To add HSMs, use the AWS CloudHSM CreateHsm operation.
  
  For the CreateCustomKeyStore, UpdateCustomKeyStore, and CreateKey operations, the AWS CloudHSM cluster must have at least two active HSMs, each in a different Availability Zone. For the ConnectCustomKeyStore operation, the AWS CloudHSM must contain at least one active HSM.
For information about the requirements for an AWS CloudHSM cluster that is associated with a custom key store, see Assemble the Prerequisites in the AWS Key Management Service Developer Guide. For information about creating a private subnet for an AWS CloudHSM cluster, see Create a Private Subnet in the AWS CloudHSM User Guide. For information about cluster security groups, see Configure a Default Security Group in the AWS CloudHSM User Guide .

CreateAlias

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

Creates a display name for a customer managed customer master key (CMK). You can use an alias to identify a CMK in cryptographic operations, such as Encrypt and GenerateDataKey. You can change the CMK associated with the alias at any time.

Aliases are easier to remember than key IDs. They can also help to simplify your applications. For example, if you use an alias in your code, you can change the CMK your code uses by associating a given alias with a different CMK.

To run the same code in multiple AWS regions, use an alias in your code, such as alias/ApplicationKey. Then, in each AWS Region, create an alias/ApplicationKey alias that is associated with a CMK in that Region. When you run your code, it uses the alias/ApplicationKey CMK for that AWS Region without any Region-specific code.

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

To use aliases successfully, be aware of the following information.

Each alias points to only one CMK at a time, although a single CMK can have multiple aliases. The alias and its associated CMK must be in the same AWS account and Region.
You can associate an alias with any customer managed CMK in the same AWS account and Region. However, you do not have permission to associate an alias with an AWS managed CMK or an AWS owned CMK.
To change the CMK associated with an alias, use the UpdateAlias operation. The current CMK and the new CMK must be the same type (both symmetric or both asymmetric) and they must have the same key usage (ENCRYPT_DECRYPT or SIGN_VERIFY). This restriction prevents cryptographic errors in code that uses aliases.
The alias name must begin with alias/ followed by a name, such as alias/ExampleAlias. 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 AWS managed CMKs.
The alias name must be unique within an AWS Region. However, you can use the same alias name in multiple Regions of the same AWS account. Each instance of the alias is associated with a CMK in its Region.
After you create an alias, you cannot change its alias name. However, you can use the DeleteAlias operation to delete the alias and then create a new alias with the desired name.
You can use an alias name or alias ARN to identify a CMK in AWS KMS cryptographic operations and in the DescribeKey operation. However, you cannot use alias names or alias ARNs in API operations that manage CMKs, such as DisableKey or GetKeyPolicy. For information about the valid CMK identifiers for each AWS KMS API operation, see the descriptions of the KeyId parameter in the API operation documentation.

Because an alias is not a property of a CMK, you can delete and change the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases and alias ARNs of CMKs in each AWS account and Region, use the ListAliases operation.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

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. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.

TargetKeyId

Required: Yes
Type: string

Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

DependencyTimeoutException:
The system timed out while trying to fulfill the request. The request can be retried.
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 AWS Key Management Service Developer Guide.
KMSInvalidStateException:
The request was rejected because the state of the specified resource is not valid for this request.

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

Examples

Example 1: To create an alias

The following example creates an alias for the specified customer master key (CMK).

$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 CMK whose alias you are creating. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
]);

CreateCustomKeyStore

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

Creates a custom key store that is associated with an AWS CloudHSM cluster that you own and manage.

This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.

Before you create the custom key store, you must assemble the required elements, including an AWS CloudHSM cluster that fulfills the requirements for a custom key store. For details about the required elements, see Assemble the Prerequisites in the AWS Key Management Service Developer Guide.

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 the new key store to its AWS CloudHSM cluster. 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 AWS Key Management Service Developer Guide.

Parameter Syntax

$result = $client->createCustomKeyStore([
    'CloudHsmClusterId' => '<string>', // REQUIRED
    'CustomKeyStoreName' => '<string>', // REQUIRED
    'KeyStorePassword' => '<string>', // REQUIRED
    'TrustAnchorCertificate' => '<string>', // REQUIRED
]);

Parameter Details

Members

CloudHsmClusterId

Required: Yes
Type: string

Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS 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 AWS account.

KeyStorePassword

Required: Yes
Type: string

Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS 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 AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.

TrustAnchorCertificate

Required: Yes
Type: string

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

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 AWS CloudHSM cluster is already associated with a custom key store or it shares a backup history with a cluster that is associated with a custom key store. Each custom key store must be associated with a different AWS CloudHSM cluster.

Clusters that share a backup history have the same cluster certificate. To view the cluster certificate of a 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 AWS KMS cannot find the AWS 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 AWS CloudHSM cluster that is associated with the custom key store is not active. Initialize and activate the cluster and try the command again. For detailed instructions, see Getting Started in the AWS CloudHSM User Guide.
IncorrectTrustAnchorException:
The request was rejected because the trust anchor certificate in the request is not the trust anchor certificate for the specified AWS CloudHSM cluster.

When you initialize the cluster, you create the trust anchor certificate and save it in the customerCA.crt file.
CloudHsmClusterInvalidConfigurationException:
The request was rejected because the associated AWS CloudHSM cluster did not meet the configuration requirements for a custom key store.
- The 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 cluster. Do not delete or change them. To get information about a particular security group, use the DescribeSecurityGroups operation.
- The cluster must contain at least as many HSMs as the operation requires. To add HSMs, use the AWS CloudHSM CreateHsm operation.
  
  For the CreateCustomKeyStore, UpdateCustomKeyStore, and CreateKey operations, the AWS CloudHSM cluster must have at least two active HSMs, each in a different Availability Zone. For the ConnectCustomKeyStore operation, the AWS CloudHSM must contain at least one active HSM.
For information about the requirements for an AWS CloudHSM cluster that is associated with a custom key store, see Assemble the Prerequisites in the AWS Key Management Service Developer Guide. For information about creating a private subnet for an AWS CloudHSM cluster, see Create a Private Subnet in the AWS CloudHSM User Guide. For information about cluster security groups, see Configure a Default Security Group in the AWS CloudHSM User Guide .

CreateGrant

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

Adds a grant to a customer master key (CMK). The grant allows the grantee principal to use the CMK when the conditions specified in the grant are met. When setting permissions, grants are an alternative to key policies.

To create a grant that allows a cryptographic operation only when the request includes a particular encryption context, use the Constraints parameter. For details, see GrantConstraints.

You can create grants on symmetric and asymmetric CMKs. However, if the grant allows an operation that the CMK does not support, CreateGrant fails with a ValidationException.

Grants for symmetric CMKs cannot allow operations that are not supported for symmetric CMKs, including Sign, Verify, and GetPublicKey. (There are limited exceptions to this rule for legacy operations, but you should not create a grant for an operation that AWS KMS does not support.)
Grants for asymmetric CMKs cannot allow operations that are not supported for asymmetric CMKs, including operations that generate data keys or data key pairs, or operations related to automatic key rotation, imported key material, or CMKs in custom key stores.
Grants for asymmetric CMKs with a KeyUsage of ENCRYPT_DECRYPT cannot allow the Sign or Verify operations. Grants for asymmetric CMKs with a KeyUsage of SIGN_VERIFY cannot allow the Encrypt or Decrypt operations.
Grants for asymmetric CMKs cannot include an encryption context grant constraint. An encryption context is not supported on asymmetric CMKs.

For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.

To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter. For more information about grants, see Grants in the AWS Key Management Service Developer Guide .

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Parameter Syntax

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

Parameter Details

Members

Constraints

Type: GrantConstraints structure

Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .

GrantTokens

Type: Array of strings

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

GranteePrincipal

Required: Yes
Type: string

The principal that is given permission to perform the operations that the grant permits.

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

KeyId

Required: Yes
Type: string

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

Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS 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 CMK, use ListKeys or DescribeKey.

Name

Type: string

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

When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.

When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.

Operations

Required: Yes
Type: Array of strings

A list of operations that the grant permits.

RetiringPrincipal

Type: string

The principal that is given permission to retire the grant by using RetireGrant operation.

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

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 subsequent RetireGrant or RevokeGrant operation.

GrantToken

Type: string

The grant token.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Errors

NotFoundException:
The request was rejected because the specified entity or resource could not be found.
DisabledException:
The request was rejected because the specified CMK is not enabled.
DependencyTimeoutException:
The system timed out while trying to fulfill the request. The request can be retried.
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 AWS Key Management Service Developer Guide.
KMSInvalidStateException:
The request was rejected because the state of the specified resource is not valid for this request.

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

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 customer master key (CMK).

$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 CMK to which the grant applies. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
    '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 customer master key (CMK) in your AWS account and Region. You cannot use this operation to create a CMK in a different AWS account.

You can use the CreateKey operation to create symmetric or asymmetric CMKs.

Symmetric CMKs contain a 256-bit symmetric key that never leaves AWS KMS unencrypted. To use the CMK, you must call AWS KMS. You can use a symmetric CMK to encrypt and decrypt small amounts of data, but they are typically used to generate data keys and data keys pairs. For details, see GenerateDataKey and GenerateDataKeyPair.
Asymmetric CMKs can contain an RSA key pair or an Elliptic Curve (ECC) key pair. The private key in an asymmetric CMK never leaves AWS KMS unencrypted. However, you can use the GetPublicKey operation to download the public key so it can be used outside of AWS KMS. CMKs with RSA key pairs can be used to encrypt or decrypt data or sign and verify messages (but not both). CMKs with ECC key pairs can be used only to sign and verify messages.

For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.

To create different types of CMKs, use the following guidance:

Asymmetric CMKs

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

Symmetric CMKs

When creating a symmetric CMK, you don't need to specify the CustomerMasterKeySpec or KeyUsage parameters. The default value for CustomerMasterKeySpec, SYMMETRIC_DEFAULT, and the default value for KeyUsage, ENCRYPT_DECRYPT, are the only valid values for symmetric CMKs.

Imported Key Material

To import your own key material, begin by creating a symmetric CMK 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, and use the 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 AWS Key Management Service Developer Guide . You cannot import the key material into an asymmetric CMK.

Custom Key Stores

To create a symmetric CMK in a custom key store, use the CustomKeyStoreId parameter to specify the custom key store. You must also use the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs in different Availability Zones in the AWS Region.

You cannot create an asymmetric CMK in a custom key store. For information about custom key stores in AWS KMS see Using Custom Key Stores in the AWS Key Management Service Developer Guide .

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',
    'Description' => '<string>',
    'KeyUsage' => 'SIGN_VERIFY|ENCRYPT_DECRYPT',
    'Origin' => 'AWS_KMS|EXTERNAL|AWS_CLOUDHSM',
    'Policy' => '<string>',
    'Tags' => [
        [
            'TagKey' => '<string>', // REQUIRED
            'TagValue' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

BypassPolicyLockoutSafetyCheck

Type: boolean

A flag to indicate whether to bypass the key policy lockout safety check.

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

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

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

The default value is false.

CustomKeyStoreId

Type: string

Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region.

This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a custom key store.

To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.

CustomerMasterKeySpec

Type: string

Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration in the AWS Key Management Service Developer Guide.

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

AWS services that are integrated with AWS KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.

AWS KMS supports the following key specs for CMKs:

Symmetric key (default)
- SYMMETRIC_DEFAULT (AES-256-GCM)
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.

Description

Type: string

A description of the CMK.

Use a description that helps you decide whether the CMK is appropriate for a task.

KeyUsage

Type: string

Determines the cryptographic operations for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the KeyUsage value after the CMK is created.

Select only one valid value.

For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.

Origin

Type: string

The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is AWS_KMS, which means AWS KMS creates the key material.

When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.

When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric CMKs.

Policy

Type: string

The key policy to attach to the CMK.

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

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

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

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

Tags

Type: Array of Tag structures

One or more tags. 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.

When you add tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by tags. For information about adding, changing, deleting and listing tags for CMKs, see Tagging Keys.

Use this parameter to tag the CMK when it is created. To add tags to an existing CMK, use the TagResource operation.

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',
        'DeletionDate' => <DateTime>,
        'Description' => '<string>',
        'Enabled' => true || false,
        'EncryptionAlgorithms' => ['<string>', ...],
        'ExpirationModel' => 'KEY_MATERIAL_EXPIRES|KEY_MATERIAL_DOES_NOT_EXPIRE',
        'KeyId' => '<string>',
        'KeyManager' => 'AWS|CUSTOMER',
        'KeyState' => 'Enabled|Disabled|PendingDeletion|PendingImport|Unavailable',
        'KeyUsage' => 'SIGN_VERIFY|ENCRYPT_DECRYPT',
        'Origin' => 'AWS_KMS|EXTERNAL|AWS_CLOUDHSM',
        'SigningAlgorithms' => ['<string>', ...],
        'ValidTo' => <DateTime>,
    ],
]

Result Details

Members

KeyMetadata

Type: KeyMetadata structure

Metadata associated with the CMK.

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. The request can be retried.
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 AWS Key Management Service Developer Guide.
TagException:
The request was rejected because one or more tags are not valid.
CustomKeyStoreNotFoundException:
The request was rejected because AWS 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 CreateKey or GenerateRandom operation in a custom key store that is not connected. These operations are valid only when the custom key store ConnectionState is CONNECTED.
- 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 ConnectCustomKeyStore operation on a custom key store with a ConnectionState of DISCONNECTING or FAILED. This operation is valid for all other ConnectionState values.
CloudHsmClusterInvalidConfigurationException:
The request was rejected because the associated AWS CloudHSM cluster did not meet the configuration requirements for a custom key store.
- The 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 cluster. Do not delete or change them. To get information about a particular security group, use the DescribeSecurityGroups operation.
- The cluster must contain at least as many HSMs as the operation requires. To add HSMs, use the AWS CloudHSM CreateHsm operation.
  
  For the CreateCustomKeyStore, UpdateCustomKeyStore, and CreateKey operations, the AWS CloudHSM cluster must have at least two active HSMs, each in a different Availability Zone. For the ConnectCustomKeyStore operation, the AWS CloudHSM must contain at least one active HSM.
For information about the requirements for an AWS CloudHSM cluster that is associated with a custom key store, see Assemble the Prerequisites in the AWS Key Management Service Developer Guide. For information about creating a private subnet for an AWS CloudHSM cluster, see Create a Private Subnet in the AWS CloudHSM User Guide. For information about cluster security groups, see Configure a Default Security Group in the AWS CloudHSM User Guide .

Examples

Example 1: To create a customer master key (CMK)

The following example creates a CMK.

$result = $client->createKey([
    'Tags' => [
        [
            'TagKey' => 'CreatedBy',
            'TagValue' => 'ExampleUser',
        ],
    ], // One or more tags. Each tag consists of a tag key and a tag value.
]);

Result syntax:

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

Decrypt

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

Decrypts ciphertext that was encrypted by a AWS KMS customer master key (CMK) 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 or asymmetric CMK. When the CMK is asymmetric, you must specify the CMK and the encryption algorithm that was used to encrypt the ciphertext. For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.

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

If the ciphertext was encrypted under a symmetric CMK, you do not need to specify the CMK or the encryption algorithm. AWS KMS can get this information from metadata that it adds to the symmetric ciphertext blob. However, if you prefer, you can specify the KeyId to ensure that a particular CMK is used to decrypt the ciphertext. If you specify a different CMK than the one used to encrypt the ciphertext, the Decrypt operation fails.

Whenever possible, use key policies to give users permission to call the Decrypt operation on a particular CMK, instead of using IAM policies. Otherwise, you might create an IAM user policy that gives the user Decrypt permission on all CMKs. This user could decrypt ciphertext that was encrypted by CMKs in other accounts if the key policy for the cross-account CMK permits it. If you must use an IAM policy for Decrypt permissions, limit the user to particular CMKs or particular trusted accounts.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Parameter Syntax

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

Parameter Details

Members

CiphertextBlob

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

Ciphertext to be decrypted. The blob includes metadata.

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 CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.

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 CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.

An encryption context is a collection of non-secret key-value pairs that represents 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 optional when encrypting with a symmetric CMK, but it is highly recommended.

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

GrantTokens

Type: Array of strings

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

KeyId

Type: string

Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext.

If you specify a KeyId value, the Decrypt operation succeeds only if the specified CMK was used to encrypt the ciphertext.

This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext. However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the ciphertext.

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/".

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 CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Result Syntax

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

Result Details

Members

EncryptionAlgorithm

Type: string

The encryption algorithm that was used to decrypt the ciphertext.

KeyId

Type: string

The ARN of the customer master key that was used to perform the decryption.

Plaintext

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

Decrypted plaintext data. When you use the HTTP API or the AWS 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 CMK 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 AWS KMS could not decrypt the encrypted (wrapped) key material.
KeyUnavailableException:
The request was rejected because the specified CMK was not available. You can retry the request.
IncorrectKeyException:
The request was rejected because the specified CMK cannot decrypt the data. The KeyId in a Decrypt request and the SourceKeyId in a ReEncrypt request must identify the same CMK that was used to encrypt the ciphertext.
InvalidKeyUsageException:
The request was rejected for one of the following reasons:
- The KeyUsage value of the CMK 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 CMK (CustomerMasterKeySpec).
For encrypting, decrypting, re-encrypting, and generating data keys, the KeyUsage must be ENCRYPT_DECRYPT. For signing and verifying, the KeyUsage must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation.

To find the encryption or signing algorithms supported for a particular CMK, use the DescribeKey operation.
DependencyTimeoutException:
The system timed out while trying to fulfill the request. The request can be retried.
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.

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

Examples

Example 1: To decrypt data

The following example decrypts data that was encrypted with a customer master key (CMK) in AWS KMS.

$result = $client->decrypt([
    'CiphertextBlob' => <BLOB>, // The encrypted data (ciphertext).
]);

Result syntax:

[
    'KeyId' => 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab', // The Amazon Resource Name (ARN) of the CMK that was used to decrypt the data.
    'Plaintext' => <BLOB>, // The decrypted (plaintext) data.
]

DeleteAlias

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

Deletes the specified alias. You cannot perform this operation on an alias in a different AWS account.

Each CMK can have multiple aliases. To change the alias of a CMK, use DeleteAlias to delete the current alias and CreateAlias to create a new alias. To associate an existing alias with a different customer master key (CMK), call 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. The request can be retried.
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.

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

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 delete the AWS CloudHSM cluster that is associated with the custom key store, or affect any users or keys in the cluster.

The custom key store that you delete cannot contain any AWS KMS customer master keys (CMKs). Before deleting the key store, verify that you will never need to use any of the CMKs in the key store for any cryptographic operations. Then, use ScheduleKeyDeletion to delete the AWS KMS customer master keys (CMKs) from the key store. When the scheduled waiting period expires, the ScheduleKeyDeletion operation deletes the CMKs. Then it 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.

After all CMKs are deleted from AWS KMS, use DisconnectCustomKeyStore to disconnect the key store from AWS KMS. Then, you can delete the custom key store.

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

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

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 AWS KMS customer master keys (CMKs). After verifying that you do not need to use the CMKs, use the ScheduleKeyDeletion operation to delete the CMKs. 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 CreateKey or GenerateRandom operation in a custom key store that is not connected. These operations are valid only when the custom key store ConnectionState is CONNECTED.
- 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 ConnectCustomKeyStore operation on a custom key store with a ConnectionState of DISCONNECTING or FAILED. This operation is valid for all other ConnectionState values.
CustomKeyStoreNotFoundException:
The request was rejected because AWS 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.

DeleteImportedKeyMaterial

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

Deletes key material that you previously imported. This operation makes the specified customer master key (CMK) unusable. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. You cannot perform this operation on a CMK in a different AWS account.

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

After you delete key material, you can use ImportKeyMaterial to reimport the same key material into the CMK.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Parameter Syntax

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

Parameter Details

Members

KeyId

Required: Yes
Type: string

Identifies the CMK from which you are deleting imported key material. The Origin of the CMK must be EXTERNAL.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

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 CMK, 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. The request can be retried.
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.

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

Examples

Example 1: To delete imported key material

The following example deletes the imported key material from the specified customer master key (CMK).

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

DescribeCustomKeyStores

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

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

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 AWS CloudHSM cluster, 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 use the DisconnectCustomKeyStore operation to disconnect it. If your custom key store state is CONNECTED but you are having trouble using it, make sure that its associated AWS CloudHSM cluster is active and contains the minimum number of HSMs required for the operation, if any.

For help repairing your custom key store, see the Troubleshooting Custom Key Stores topic in the AWS Key Management Service Developer Guide.

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, you can use 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, AWS 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',
            'ConnectionState' => 'CONNECTED|CONNECTING|FAILED|DISCONNECTED|DISCONNECTING',
            'CreationDate' => <DateTime>,
            'CustomKeyStoreId' => '<string>',
            'CustomKeyStoreName' => '<string>',
            'TrustAnchorCertificate' => '<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 AWS 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.

DescribeKey

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

Provides detailed information about a customer master key (CMK). You can run DescribeKey on a customer managed CMK or an AWS managed CMK.

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. For CMKs in custom key stores, it includes information about the custom key store, such as the key store ID and the AWS CloudHSM cluster ID. It includes fields, like KeySpec, that help you distinguish symmetric from asymmetric CMKs. It also provides information that is particularly important to asymmetric CMKs, such as the key usage (encryption or signing) and the encryption algorithms or signing algorithms that the CMK supports.

DescribeKey does not return the following information:

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

If you call the DescribeKey operation on a predefined AWS alias, that is, an AWS alias with no key ID, AWS KMS creates an AWS managed CMK. Then, it associates the alias with the new CMK, and returns the KeyId and Arn of the new CMK in the response.

To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.

Parameter Syntax

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

Parameter Details

Members

GrantTokens

Type: Array of strings

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

KeyId

Required: Yes
Type: string

Describes the specified customer master key (CMK).

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

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a CMK in a different AWS 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 CMK, 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',
        'DeletionDate' => <DateTime>,
        'Description' => '<string>',
        'Enabled' => true || false,
        'EncryptionAlgorithms' => ['<string>', ...],
        'ExpirationModel' => 'KEY_MATERIAL_EXPIRES|KEY_MATERIAL_DOES_NOT_EXPIRE',
        'KeyId' => '<string>',
        'KeyManager' => 'AWS|CUSTOMER',
        'KeyState' => 'Enabled|Disabled|PendingDeletion|PendingImport|Unavailable',
        'KeyUsage' => 'SIGN_VERIFY|ENCRYPT_DECRYPT',
        'Origin' => 'AWS_KMS|EXTERNAL|AWS_CLOUDHSM',
        'SigningAlgorithms' => ['<string>', ...],
        'ValidTo' => <DateTime>,
    ],
]

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. The request can be retried.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.

Examples

Example 1: To obtain information about a customer master key (CMK)

The following example returns information (metadata) about the specified CMK.

$result = $client->describeKey([
    'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab', // The identifier of the CMK that you want information about. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
]);

Result syntax:

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

DisableKey

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

Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic operations. You cannot perform this operation on a CMK in a different AWS account.

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

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Parameter Syntax

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

Parameter Details

Members

KeyId

Required: Yes
Type: string

A unique identifier for the customer master key (CMK).

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

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 CMK, 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. The request can be retried.
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.

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

Examples

Example 1: To disable a customer master key (CMK)

The following example disables the specified CMK.

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

DisableKeyRotation

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

Disables automatic rotation of the key material for the specified symmetric customer master key (CMK).

You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. You cannot perform this operation on a CMK in a different AWS account.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Parameter Syntax

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

Parameter Details

Members

KeyId

Required: Yes
Type: string

Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

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 CMK, 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 CMK 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. The request can be retried.
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.

For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide .
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 CMK.

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

DisconnectCustomKeyStore

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

Disconnects the custom key store from its associated AWS CloudHSM cluster. While a custom key store is disconnected, you can manage the custom key store and its customer master keys (CMKs), but you cannot create or use CMKs in the custom key store. You can reconnect the custom key store at any time.

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

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.

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 CreateKey or GenerateRandom operation in a custom key store that is not connected. These operations are valid only when the custom key store ConnectionState is CONNECTED.
- 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 ConnectCustomKeyStore operation on a custom key store with a ConnectionState of DISCONNECTING or FAILED. This operation is valid for all other ConnectionState values.
CustomKeyStoreNotFoundException:
The request was rejected because AWS 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.

EnableKey

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

Sets the key state of a customer master key (CMK) to enabled. This allows you to use the CMK for cryptographic operations. You cannot perform this operation on a CMK in a different AWS account.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Parameter Syntax

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

Parameter Details

Members

KeyId

Required: Yes
Type: string

A unique identifier for the customer master key (CMK).

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

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 CMK, 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. The request can be retried.
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 AWS Key Management Service Developer Guide.
KMSInvalidStateException:
The request was rejected because the state of the specified resource is not valid for this request.

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

Examples

Example 1: To enable a customer master key (CMK)

The following example enables the specified CMK.

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

EnableKeyRotation

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

Enables automatic rotation of the key material for the specified symmetric customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.

You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Parameter Syntax

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

Parameter Details

Members

KeyId

Required: Yes
Type: string

Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

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 CMK, 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 CMK 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. The request can be retried.
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.

For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide .
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 CMK.

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

Encrypt

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

Encrypts plaintext into ciphertext by using a customer master key (CMK). The Encrypt operation has two primary use cases:

You can encrypt small amounts of arbitrary data, such as a personal identifier or database password, or other sensitive information.
You can use the Encrypt operation to move encrypted data from one AWS region to another. In the first region, generate a data key and use the plaintext key to encrypt the data. Then, in the new region, call the Encrypt method on same plaintext data key. Now, you can safely move the encrypted data and encrypted data key to the new region, and decrypt in the new region when necessary.

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.

When you encrypt data, you must specify a symmetric or asymmetric CMK to use in the encryption operation. The CMK must have a KeyUsage value of ENCRYPT_DECRYPT. To find the KeyUsage of a CMK, use the DescribeKey operation.

If you use a symmetric CMK, 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 AWS Key Management Service Developer Guide.

If you specify an asymmetric CMK, you must also specify the encryption algorithm. The algorithm must be compatible with the CMK type.

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

You are not required to supply the CMK ID and encryption algorithm when you decrypt with symmetric CMKs because AWS KMS stores this information in the ciphertext blob. AWS 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 CMK and the encryption algorithm that you choose.

Symmetric CMKs
- 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

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.

Parameter Syntax

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

Parameter Details

Members

EncryptionAlgorithm

Type: string

Specifies the encryption algorithm that AWS KMS will use to encrypt the plaintext message. The algorithm must be compatible with the CMK that you specify.

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

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 CMK. The standard asymmetric encryption algorithms that AWS KMS uses do not support an encryption context.

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

GrantTokens

Type: Array of strings

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

KeyId

Required: Yes
Type: string

A unique identifier for the customer master key (CMK).

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 CMK, 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',
    '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 AWS 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 ID of the key used during encryption.

Errors

NotFoundException:
The request was rejected because the specified entity or resource could not be found.
DisabledException:
The request was rejected because the specified CMK is not enabled.
KeyUnavailableException:
The request was rejected because the specified CMK was not available. You can retry the request.
DependencyTimeoutException:
The system timed out while trying to fulfill the request. The request can be retried.
InvalidKeyUsageException:
The request was rejected for one of the following reasons:
- The KeyUsage value of the CMK 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 CMK (CustomerMasterKeySpec).
For encrypting, decrypting, re-encrypting, and generating data keys, the KeyUsage must be ENCRYPT_DECRYPT. For signing and verifying, the KeyUsage must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation.

To find the encryption or signing algorithms supported for a particular CMK, 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.

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

Examples

Example 1: To encrypt data

The following example encrypts data with the specified customer master key (CMK).

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

Result syntax:

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

GenerateDataKey

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

Generates a unique symmetric data key. This operation returns a plaintext copy of the data key and a copy that is encrypted under a customer master key (CMK) that you specify. You can use the plaintext key to encrypt your data outside of AWS KMS and store the encrypted data key with the encrypted data.

GenerateDataKey returns a unique data key for each request. The bytes in the key are not related to the caller or CMK that is used to encrypt the data key.

To generate a data key, specify the symmetric CMK that will be used to encrypt the data key. You cannot use an asymmetric CMK to generate data keys. To get the type of your CMK, 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.

If the operation succeeds, the plaintext copy of the data key is in the Plaintext field of the response, and the encrypted copy of the data key in the CiphertextBlob field.

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

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

We recommend that you use the following pattern to encrypt data locally in your application:

Use the GenerateDataKey operation to get a data encryption key.
Use the plaintext data key (returned in the Plaintext field of the response) to encrypt data locally, then erase the plaintext data key from memory.
Store the encrypted data key (returned in the CiphertextBlob field of the response) alongside the locally encrypted data.

To decrypt data locally:

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

Parameter Syntax

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

Parameter Details

Members

EncryptionContext

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

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

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

GrantTokens

Type: Array of strings

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

KeyId

Required: Yes
Type: string

Identifies the symmetric CMK that encrypts the data 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 CMK, 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.

Result Syntax

[
    'CiphertextBlob' => <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 AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

KeyId

Type: string

The identifier of the CMK 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 AWS 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.

Errors

NotFoundException:
The request was rejected because the specified entity or resource could not be found.
DisabledException:
The request was rejected because the specified CMK is not enabled.
KeyUnavailableException:
The request was rejected because the specified CMK was not available. You can retry the request.
DependencyTimeoutException:
The system timed out while trying to fulfill the request. The request can be retried.
InvalidKeyUsageException:
The request was rejected for one of the following reasons:
- The KeyUsage value of the CMK 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 CMK (CustomerMasterKeySpec).
For encrypting, decrypting, re-encrypting, and generating data keys, the KeyUsage must be ENCRYPT_DECRYPT. For signing and verifying, the KeyUsage must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation.

To find the encryption or signing algorithms supported for a particular CMK, 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.

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

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 customer master key (CMK).

$result = $client->generateDataKey([
    'KeyId' => 'alias/ExampleAlias', // The identifier of the CMK to use to encrypt the data key. You can use the key ID or Amazon Resource Name (ARN) of the CMK, or the name or ARN of an alias that refers to the CMK.
    '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 CMK that was used to encrypt the data key.
    'Plaintext' => <BLOB>, // The unencrypted (plaintext) data key.
]

GenerateDataKeyPair

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

Generates a unique asymmetric data key pair. The GenerateDataKeyPair operation returns a plaintext public key, a plaintext private key, and a copy of the private key that is encrypted under the symmetric CMK you specify. You can use the data key pair to perform asymmetric cryptography outside of AWS KMS.

GenerateDataKeyPair returns a unique data key pair for each request. The bytes in the keys are not related to the caller or the CMK 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 AWS 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 customer master key (CMK) to encrypt the private key in a data key pair. You cannot use an asymmetric CMK. To get the type of your CMK, use the DescribeKey operation.

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.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Parameter Syntax

$result = $client->generateDataKeyPair([
    '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', // REQUIRED
]);

Parameter Details

Members

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.

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

GrantTokens

Type: Array of strings

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

KeyId

Required: Yes
Type: string

Specifies the symmetric CMK that encrypts the private key in the data key pair. You cannot specify an asymmetric CMKs.

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 CMK, 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 AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not effective outside of AWS KMS.

Result Syntax

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

Result Details

Members

KeyId

Type: string

The identifier of the CMK 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 AWS 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 AWS 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).

Errors

NotFoundException:
The request was rejected because the specified entity or resource could not be found.
DisabledException:
The request was rejected because the specified CMK is not enabled.
KeyUnavailableException:
The request was rejected because the specified CMK was not available. You can retry the request.
DependencyTimeoutException:
The system timed out while trying to fulfill the request. The request can be retried.
InvalidKeyUsageException:
The request was rejected for one of the following reasons:
- The KeyUsage value of the CMK 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 CMK (CustomerMasterKeySpec).
For encrypting, decrypting, re-encrypting, and generating data keys, the KeyUsage must be ENCRYPT_DECRYPT. For signing and verifying, the KeyUsage must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation.

To find the encryption or signing algorithms supported for a particular CMK, 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.

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

GenerateDataKeyPairWithoutPlaintext

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

Generates a unique asymmetric data key pair. The GenerateDataKeyPairWithoutPlaintext operation returns a plaintext public key and a copy of the private key that is encrypted under the symmetric CMK you specify. Unlike GenerateDataKeyPair, this operation does not return a plaintext private key.

To generate a data key pair, you must specify a symmetric customer master key (CMK) to encrypt the private key in the data key pair. You cannot use an asymmetric CMK. To get the type of your CMK, use the KeySpec field in the DescribeKey response.

You can use the public key that GenerateDataKeyPairWithoutPlaintext returns to encrypt data or verify a signature outside of AWS 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 CMK that is used to encrypt the private key.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Parameter Syntax

$result = $client->generateDataKeyPairWithoutPlaintext([
    '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', // REQUIRED
]);

Parameter Details

Members

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.

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

GrantTokens

Type: Array of strings

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

KeyId

Required: Yes
Type: string

Specifies the CMK that encrypts the private key in the data key pair. You must specify a symmetric CMK. You cannot use an asymmetric CMK. To get the type of your CMK, use the DescribeKey operation.

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/".

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 CMK, 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',
    'PrivateKeyCiphertextBlob' => <string || resource || Psr\Http\Message\StreamInterface>,
    'PublicKey' => <string || resource || Psr\Http\Message\StreamInterface>,
]

Result Details

Members

KeyId

Type: string

Specifies the CMK that encrypted the private key in the data key pair. You must specify a symmetric CMK. You cannot use an asymmetric CMK. To get the type of your CMK, use the DescribeKey operation.

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/".

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 CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

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

Errors

NotFoundException:
The request was rejected because the specified entity or resource could not be found.
DisabledException:
The request was rejected because the specified CMK is not enabled.
KeyUnavailableException:
The request was rejected because the specified CMK was not available. You can retry the request.
DependencyTimeoutException:
The system timed out while trying to fulfill the request. The request can be retried.
InvalidKeyUsageException:
The request was rejected for one of the following reasons:
- The KeyUsage value of the CMK 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 CMK (CustomerMasterKeySpec).
For encrypting, decrypting, re-encrypting, and generating data keys, the KeyUsage must be ENCRYPT_DECRYPT. For signing and verifying, the KeyUsage must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation.

To find the encryption or signing algorithms supported for a particular CMK, 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.

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

GenerateDataKeyWithoutPlaintext

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

Generates a unique symmetric data key. This operation returns a data key that is encrypted under a customer master key (CMK) that you specify. To request an asymmetric data key pair, use the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operations.

GenerateDataKeyWithoutPlaintext is identical to the GenerateDataKey operation except that returns only the encrypted 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.

GenerateDataKeyWithoutPlaintext returns a unique data key for each request. The bytes in the keys are not related to the caller or CMK that is used to encrypt the private key.

To generate a data key, you must specify the symmetric customer master key (CMK) that is used to encrypt the data key. You cannot use an asymmetric CMK to generate a data key. To get the type of your CMK, use the DescribeKey operation.

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

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Parameter Syntax

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

Parameter Details

Members

EncryptionContext

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

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

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

GrantTokens

Type: Array of strings

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

KeyId

Required: Yes
Type: string

The identifier of the symmetric customer master key (CMK) that encrypts the data 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 CMK, 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 AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

KeyId

Type: string

The identifier of the CMK 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 CMK is not enabled.
KeyUnavailableException:
The request was rejected because the specified CMK was not available. You can retry the request.
DependencyTimeoutException:
The system timed out while trying to fulfill the request. The request can be retried.
InvalidKeyUsageException:
The request was rejected for one of the following reasons:
- The KeyUsage value of the CMK 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 CMK (CustomerMasterKeySpec).
For encrypting, decrypting, re-encrypting, and generating data keys, the KeyUsage must be ENCRYPT_DECRYPT. For signing and verifying, the KeyUsage must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation.

To find the encryption or signing algorithms supported for a particular CMK, 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.

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

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 customer master key (CMK).

$result = $client->generateDataKeyWithoutPlaintext([
    'KeyId' => 'alias/ExampleAlias', // The identifier of the CMK to use to encrypt the data key. You can use the key ID or Amazon Resource Name (ARN) of the CMK, or the name or ARN of an alias that refers to the CMK.
    '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 CMK that was used to encrypt the data key.
]

GenerateRandom

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

Returns a random byte string that is cryptographically secure.

By default, the random byte string is generated in AWS KMS. To generate the byte string in the AWS CloudHSM cluster that is associated with a custom key store, specify the custom key store ID.

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

Parameter Syntax

$result = $client->generateRandom([
    'CustomKeyStoreId' => '<string>',
    'NumberOfBytes' => <integer>,
]);

Parameter Details

Members

CustomKeyStoreId

Type: string

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

NumberOfBytes

Type: int

The length of the byte string.

Result Syntax

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

Result Details

Members

Plaintext

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

The random byte string. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

Errors

DependencyTimeoutException:
The system timed out while trying to fulfill the request. The request can be retried.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
CustomKeyStoreNotFoundException:
The request was rejected because AWS 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 CreateKey or GenerateRandom operation in a custom key store that is not connected. These operations are valid only when the custom key store ConnectionState is CONNECTED.
- 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 ConnectCustomKeyStore operation on a custom key store with a ConnectionState of DISCONNECTING or FAILED. This operation is valid for all other ConnectionState values.

Examples

Example 1: To generate random data

The following example uses AWS KMS to generate 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.
]

GetKeyPolicy

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

Gets a key policy attached to the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.

Parameter Syntax

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

Parameter Details

Members

KeyId

Required: Yes
Type: string

A unique identifier for the customer master key (CMK).

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

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 CMK, 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. The request can be retried.
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.

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

Examples

Example 1: To retrieve a key policy

The following example retrieves the key policy for the specified customer master key (CMK).

$result = $client->getKeyPolicy([
    'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab', // The identifier of the CMK whose key policy you want to retrieve. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
    '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 customer master key (CMK).

You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. The key rotation status for these CMKs is always false.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Disabled: The key rotation status does not change when you disable a CMK. However, while the CMK is disabled, AWS KMS does not rotate the backing key.
Pending deletion: While a CMK is pending deletion, its key rotation status is false and AWS KMS does not rotate the backing key. If you cancel the deletion, the original key rotation status is restored.

To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter.

Parameter Syntax

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

Parameter Details

Members

KeyId

Required: Yes
Type: string

A unique identifier for the customer master key (CMK).

Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS 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 CMK, 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. The request can be retried.
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.

For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide .
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 customer master key (CMK)

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

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

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 items you need to import key material into a symmetric, customer managed customer master key (CMK). For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.

This operation returns a public key and an import token. Use the public key to encrypt the symmetric key material. Store the import token to send with a subsequent ImportKeyMaterial request.

You must specify the key ID of the symmetric CMK into which you will import key material. This CMK's Origin must be EXTERNAL. You must also specify the wrapping algorithm and type of wrapping key (public key) that you will use to encrypt the key material. You cannot perform this operation on an asymmetric CMK or on any CMK in a different AWS account.

To import key material, you must use the public key and import token from the same response. These items are valid for 24 hours. The expiration date and time appear in the GetParametersForImport response. You cannot use an expired token in an ImportKeyMaterial request. If your key and token expire, send another GetParametersForImport request.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Parameter Syntax

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

Parameter Details

Members

KeyId

Required: Yes
Type: string

The identifier of the symmetric CMK into which you will import key material. The Origin of the CMK must be EXTERNAL.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

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 CMK, use ListKeys or DescribeKey.

WrappingAlgorithm

Required: Yes
Type: string

The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial. For more information, see Encrypt the Key Material in the AWS Key Management Service Developer Guide.

WrappingKeySpec

Required: Yes
Type: string

The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are supported.

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 identifier of the CMK to use in a subsequent ImportKeyMaterial request. This is the same CMK 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. The request can be retried.
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.

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

Examples

Example 1: To retrieve the public key and import token for a customer master key (CMK)

The following example retrieves the public key and import token for the specified CMK.

$result = $client->getParametersForImport([
    'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab', // The identifier of the CMK for which to retrieve the public key and import token. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
    '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 CMK for which you are retrieving the public key and import token. This is the same CMK specified in the request.
    'ParametersValidTo' => , // The time at which the import token and public key are no longer valid.
    '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 CMK. Unlike the private key of a asymmetric CMK, which never leaves AWS KMS unencrypted, callers with kms:GetPublicKey permission can download the public key of an asymmetric CMK. You can share the public key to allow others to encrypt messages and verify signatures outside of AWS KMS. For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.

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

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

CustomerMasterKeySpec: 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 AWS 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 AWS KMS. You can also avoid errors, such as using the wrong signing algorithm in a verification operation.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Parameter Syntax

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

Parameter Details

Members

GrantTokens

Type: Array of strings

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

KeyId

Required: Yes
Type: string

Identifies the asymmetric CMK 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 CMK, 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',
    'EncryptionAlgorithms' => ['<string>', ...],
    'KeyId' => '<string>',
    'KeyUsage' => 'SIGN_VERIFY|ENCRYPT_DECRYPT',
    'PublicKey' => <string || resource || Psr\Http\Message\StreamInterface>,
    'SigningAlgorithms' => ['<string>', ...],
]

Result Details

Members

CustomerMasterKeySpec

Type: string

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

EncryptionAlgorithms

Type: Array of strings

The encryption algorithms that AWS KMS supports for this key.

This information is critical. If a public key encrypts data outside of AWS 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 identifier of the asymmetric CMK from which the public key 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 AWS KMS, the ciphertext cannot be decrypted.

PublicKey

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

The exported public key.

This value is returned as a binary Distinguished Encoding Rules (DER)-encoded object. To decode it, use an ASN.1 parsing tool, such as OpenSSL asn1parse.

SigningAlgorithms

Type: Array of strings

The signing algorithms that AWS 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 CMK is not enabled.
KeyUnavailableException:
The request was rejected because the specified CMK was not available. You can retry the request.
DependencyTimeoutException:
The system timed out while trying to fulfill the request. 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.
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 CMK 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 CMK (CustomerMasterKeySpec).
For encrypting, decrypting, re-encrypting, and generating data keys, the KeyUsage must be ENCRYPT_DECRYPT. For signing and verifying, the KeyUsage must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation.

To find the encryption or signing algorithms supported for a particular CMK, 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.

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

ImportKeyMaterial

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

Imports key material into an existing symmetric AWS KMS customer master key (CMK) that was created without key material. After you successfully import key material into a CMK, you can reimport the same key material into that CMK, but you cannot import different key material.

You cannot perform this operation on an asymmetric CMK or on any CMK in a different AWS account. For more information about creating CMKs with no key material and then importing key material, see Importing Key Material in the AWS Key Management Service Developer Guide.

Before using this operation, call GetParametersForImport. Its response includes a public key and an import token. Use the public key to encrypt the key material. Then, submit the import token from the same GetParametersForImport response.

When calling this operation, you must specify the following values:

The key ID or key ARN of a CMK with no key material. Its Origin must be EXTERNAL.

To create a CMK with no key material, call CreateKey and set the value of its Origin parameter to EXTERNAL. To get the Origin of a CMK, call DescribeKey.)
The encrypted key material. To get the public key to encrypt the key material, call GetParametersForImport.
The import token that GetParametersForImport returned. You must use a public key and token from the same GetParametersForImport response.
Whether the key material expires and if so, when. If you set an expiration date, AWS KMS deletes the key material from the CMK on the specified date, and the CMK becomes unusable. To use the CMK again, you must reimport the same key material. The only way to change an expiration date is by reimporting the same key material and specifying a new expiration date.

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

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 CMK and repeat the import procedure. For help, see How To Import Key Material in the AWS Key Management Service Developer Guide.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

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 with 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, in which case you must include the ValidTo parameter. When this parameter is set to KEY_MATERIAL_DOES_NOT_EXPIRE, you must omit the ValidTo parameter.

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 symmetric CMK that receives the imported key material. The CMK's Origin must be EXTERNAL. This must be the same CMK specified in the KeyID parameter of the corresponding GetParametersForImport request.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

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 CMK, use ListKeys or DescribeKey.

ValidTo

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

The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. You must omit this parameter when the ExpirationModel parameter is set to KEY_MATERIAL_DOES_NOT_EXPIRE. Otherwise it is required.

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. The request can be retried.
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.

For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide .
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 AWS 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 customer master key (CMK).
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 customer master key (CMK).

Examples

Example 1: To import key material into a customer master key (CMK)

The following example imports key material into the specified CMK.

$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 CMK to import the key material into. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
]);

ListAliases

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

Gets a list of aliases in the caller's AWS account and region. You cannot list aliases in other accounts. For more information about aliases, see CreateAlias.

By default, the ListAliases command returns all aliases in the account and region. To get only the aliases that point to a particular customer master key (CMK), use the KeyId parameter.

The ListAliases response can include aliases that you created and associated with your customer managed CMKs, and aliases that AWS created and associated with AWS managed CMKs in your account. You can recognize AWS 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 AWS has created but has not yet associated with a CMK. Aliases that AWS creates in your account, including predefined aliases, do not count against your AWS KMS aliases quota.

Parameter Syntax

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

Parameter Details

Members

KeyId

Type: string

Lists only aliases that refer to the specified CMK. The value of this parameter can be the ID or Amazon Resource Name (ARN) of a CMK in the caller's account and region. You cannot use an alias name or alias ARN in this value.

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

Limit

Type: int

Use this parameter to specify the maximum number of items to return. When this value is present, AWS 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>',
            '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. The request can be retried.
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 customer master key (CMK) 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 customer master key (CMK).

To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter.

Parameter Syntax

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

Parameter Details

Members

KeyId

Required: Yes
Type: string

A unique identifier for the customer master key (CMK).

Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS 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 CMK, use ListKeys or DescribeKey.

Limit

Type: int

Use this parameter to specify the maximum number of items to return. When this value is present, AWS 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. The request can be retried.
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.
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.

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

Examples

Example 1: To list grants for a customer master key (CMK)

The following example lists grants for the specified CMK.

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

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 customer master key (CMK). This operation is designed to get policy names that you can use in a GetKeyPolicy operation. However, the only valid policy name is default. You cannot perform this operation on a CMK in a different AWS account.

Parameter Syntax

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

Parameter Details

Members

KeyId

Required: Yes
Type: string

A unique identifier for the customer master key (CMK).

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

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 CMK, use ListKeys or DescribeKey.

Limit

Type: int

Use this parameter to specify the maximum number of items to return. When this value is present, AWS 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. The request can be retried.
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.

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

Examples

Example 1: To list key policies for a customer master key (CMK)

The following example lists key policies for the specified CMK.

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

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 customer master keys (CMKs) in the caller's AWS account and Region.

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, AWS 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 customer master keys (CMKs).

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. The request can be retried.
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 customer master keys (CMKs)

The following example lists CMKs.

$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 CMKs, 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 a list of all tags for the specified customer master key (CMK).

You cannot perform this operation on a CMK in a different AWS account.

Parameter Syntax

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

Parameter Details

Members

KeyId

Required: Yes
Type: string

A unique identifier for the customer master key (CMK).

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

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 CMK, use ListKeys or DescribeKey.

Limit

Type: int

Use this parameter to specify the maximum number of items to return. When this value is present, AWS 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.

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 customer master key (CMK)

The following example lists tags for a CMK.

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

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 a list of all grants for which the grant's RetiringPrincipal matches the one specified.

A typical use is to list all grants that you are able to retire. To retire a grant, use RetireGrant.

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

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

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. The request can be retried.
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 an AWS 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 customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.

For more information about key policies, see Key Policies in the AWS Key Management Service Developer Guide.

Parameter Syntax

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

Parameter Details

Members

BypassPolicyLockoutSafetyCheck

Type: boolean

A flag to indicate whether to bypass the key policy lockout safety check.

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

For more information, refer to the scenario in the Default Key Policy section in the AWS 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 CMK.

The default value is false.

KeyId

Required: Yes
Type: string

A unique identifier for the customer master key (CMK).

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

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 CMK, use ListKeys or DescribeKey.

Policy

Required: Yes
Type: string

The key policy to attach to the CMK.

The key policy must meet the following criteria:

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

The key policy cannot exceed 32 kilobytes (32768 bytes). For more information, see Resource Quotas in the AWS Key Management Service Developer 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. 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.
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 AWS Key Management Service Developer Guide.
KMSInvalidStateException:
The request was rejected because the state of the specified resource is not valid for this request.

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

Examples

Example 1: To attach a key policy to a customer master key (CMK)

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

$result = $client->putKeyPolicy([
    'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab', // The identifier of the CMK to attach the key policy to. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
    '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 AWS KMS. You can use this operation to change the customer master key (CMK) under which data is encrypted, such as when you manually rotate a CMK or change the CMK that protects a ciphertext. You can also use it to reencrypt ciphertext under the same CMK, such as to change the encryption context of a ciphertext.

The ReEncrypt operation can decrypt ciphertext that was encrypted by using an AWS KMS CMK in an AWS KMS operation, such as Encrypt or GenerateDataKey. It can also decrypt ciphertext that was encrypted by using the public key of an asymmetric CMK outside of AWS KMS. However, it cannot decrypt ciphertext produced by other libraries, such as the AWS Encryption SDK or Amazon S3 client-side encryption. These libraries return a ciphertext format that is incompatible with AWS 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 CMK, you must identify the source CMK, that is, the CMK that encrypted the ciphertext. You must also supply the encryption algorithm that was used. This information is required to decrypt the data.
It is optional, but you can specify a source CMK even when the ciphertext was encrypted under a symmetric CMK. This ensures that the ciphertext is decrypted only by using a particular CMK. If the CMK that you specify cannot decrypt the ciphertext, the ReEncrypt operation fails.
To reencrypt the data, you must specify the destination CMK, that is, the CMK that re-encrypts the data after it is decrypted. You can select a symmetric or asymmetric CMK. If the destination CMK is an asymmetric CMK, you must also provide the encryption algorithm. The algorithm that you choose must be compatible with the CMK.

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

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

Unlike other AWS KMS API operations, ReEncrypt callers must have two permissions:

kms:EncryptFrom permission on the source CMK
kms:EncryptTo permission on the destination CMK

To permit reencryption from

or to a CMK, 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 CMK. But you must include it manually when you create a CMK programmatically or when you use the PutKeyPolicy operation set a key policy.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Parameter Syntax

$result = $client->reEncrypt([
    'CiphertextBlob' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
    'DestinationEncryptionAlgorithm' => 'SYMMETRIC_DEFAULT|RSAES_OAEP_SHA_1|RSAES_OAEP_SHA_256',
    'DestinationEncryptionContext' => ['<string>', ...],
    'DestinationKeyId' => '<string>', // REQUIRED
    'GrantTokens' => ['<string>', ...],
    'SourceEncryptionAlgorithm' => 'SYMMETRIC_DEFAULT|RSAES_OAEP_SHA_1|RSAES_OAEP_SHA_256',
    '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 AWS KMS will use to reecrypt the data after it has decrypted it. The default value, SYMMETRIC_DEFAULT, represents the encryption algorithm used for symmetric CMKs.

This parameter is required only when the destination CMK is an asymmetric CMK.

DestinationEncryptionContext

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

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

A destination encryption context is valid only when the destination CMK is a symmetric CMK. The standard ciphertext format for asymmetric CMKs does not include fields for metadata.

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

DestinationKeyId

Required: Yes
Type: string

A unique identifier for the CMK that is used to reencrypt the data. Specify a symmetric or asymmetric CMK with a KeyUsage value of ENCRYPT_DECRYPT. To find the KeyUsage value of a CMK, 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 CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

GrantTokens

Type: Array of strings

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

SourceEncryptionAlgorithm

Type: string

Specifies the encryption algorithm that AWS KMS will use to decrypt the ciphertext before it is reencrypted. The default value, SYMMETRIC_DEFAULT, represents the algorithm used for symmetric CMKs.

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

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 AWS Key Management Service Developer Guide.

SourceKeyId

Type: string

A unique identifier for the CMK that is used to decrypt the ciphertext before it reencrypts it using the destination CMK.

If you specify a KeyId value, the decrypt part of the ReEncrypt operation succeeds only if the specified CMK was used to encrypt the ciphertext.

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/".

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 CMK, 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',
    'KeyId' => '<string>',
    'SourceEncryptionAlgorithm' => 'SYMMETRIC_DEFAULT|RSAES_OAEP_SHA_1|RSAES_OAEP_SHA_256',
    '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 AWS 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

Unique identifier of the CMK 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 CMK 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 CMK 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 AWS KMS could not decrypt the encrypted (wrapped) key material.
KeyUnavailableException:
The request was rejected because the specified CMK was not available. You can retry the request.
IncorrectKeyException:
The request was rejected because the specified CMK cannot decrypt the data. The KeyId in a Decrypt request and the SourceKeyId in a ReEncrypt request must identify the same CMK that was used to encrypt the ciphertext.
DependencyTimeoutException:
The system timed out while trying to fulfill the request. The request can be retried.
InvalidKeyUsageException:
The request was rejected for one of the following reasons:
- The KeyUsage value of the CMK 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 CMK (CustomerMasterKeySpec).
For encrypting, decrypting, re-encrypting, and generating data keys, the KeyUsage must be ENCRYPT_DECRYPT. For signing and verifying, the KeyUsage must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation.

To find the encryption or signing algorithms supported for a particular CMK, 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.

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

Examples

Example 1: To reencrypt data

The following example reencrypts data with the specified CMK.

$result = $client->reEncrypt([
    'CiphertextBlob' => <BLOB>, // The data to reencrypt.
    'DestinationKeyId' => '0987dcba-09fe-87dc-65ba-ab0987654321', // The identifier of the CMK to use to reencrypt the data. You can use the key ID or Amazon Resource Name (ARN) of the CMK, or the name or ARN of an alias that refers to the CMK.
]);

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 CMK 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 CMK that was used to originally encrypt the data.
]

RetireGrant

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

Retires a grant. To clean up, you can retire a grant when you're done using it. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API:

The AWS account (root user) under which the grant was created
The RetiringPrincipal, if present in the grant
The GranteePrincipal, if RetireGrant is an operation specified in the grant

You must identify the grant to retire by its grant token or by a combination of the grant ID and the Amazon Resource Name (ARN) of the customer master key (CMK). A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. The CreateGrant operation returns both.

Parameter Syntax

$result = $client->retireGrant([
    'GrantId' => '<string>',
    'GrantToken' => '<string>',
    'KeyId' => '<string>',
]);

Parameter Details

Members

GrantId

Type: string

Unique identifier of the grant to retire. The grant ID is returned in the response to a CreateGrant operation.

Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

GrantToken

Type: string

Token that identifies the grant to be retired.

KeyId

Type: string

The Amazon Resource Name (ARN) of the CMK associated with the grant.

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. The request can be retried.
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.

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

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 customer master key (CMK) associated with the grant.
]);

RevokeGrant

$result = $client->revokeGrant([/* ... */]);
$promise = $client->revokeGrantAsync([/* ... */]);

Revokes the specified grant for the specified customer master key (CMK). You can revoke a grant to actively deny operations that depend on it.

To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter.

Parameter Syntax

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

Parameter Details

Members

GrantId

Required: Yes
Type: string

Identifier of the grant to be revoked.

KeyId

Required: Yes
Type: string

A unique identifier for the customer master key associated with the grant.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS 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 CMK, 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. The request can be retried.
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.

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

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 customer master key (CMK) associated with the grant. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
]);

ScheduleKeyDeletion

$result = $client->scheduleKeyDeletion([/* ... */]);
$promise = $client->scheduleKeyDeletionAsync([/* ... */]);

Schedules the deletion of a customer master key (CMK). You may provide a waiting period, specified in days, before deletion occurs. If you do not provide a waiting period, the default period of 30 days is used. When this operation is successful, the key state of the CMK changes to PendingDeletion. Before the waiting period ends, you can use CancelKeyDeletion to cancel the deletion of the CMK. After the waiting period ends, AWS KMS deletes the CMK and all AWS KMS data associated with it, including all aliases that refer to it.

Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is unrecoverable. To prevent the use of a CMK without deleting it, use DisableKey.

If you schedule deletion of a CMK from a custom key store, when the waiting period expires, ScheduleKeyDeletion deletes the CMK from AWS KMS. Then AWS KMS makes a best effort to delete the key material from the associated AWS CloudHSM cluster. However, you might need to manually delete the orphaned key material from the cluster and its backups.

You cannot perform this operation on a CMK in a different AWS account.

For more information about scheduling a CMK for deletion, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Parameter Syntax

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

Parameter Details

Members

KeyId

Required: Yes
Type: string

The unique identifier of the customer master key (CMK) to delete.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

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 CMK, use ListKeys or DescribeKey.

PendingWindowInDays

Type: int

The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the customer master key (CMK).

This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30.

Result Syntax

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

Result Details

Members

DeletionDate

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

The date and time after which AWS KMS deletes the customer master key (CMK).

KeyId

Type: string

The unique identifier of the customer master key (CMK) for which deletion is scheduled.

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. The request can be retried.
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.

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

Examples

Example 1: To schedule a customer master key (CMK) for deletion

The following example schedules the specified CMK for deletion.

$result = $client->scheduleKeyDeletion([
    'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab', // The identifier of the CMK to schedule for deletion. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
    'PendingWindowInDays' => 7, // The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the CMK.
]);

Result syntax:

[
    'DeletionDate' => , // The date and time after which AWS KMS deletes the CMK.
    'KeyId' => 'arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab', // The ARN of the CMK 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 CMK. To verify the signature, use the Verify operation, or use the public key in the same asymmetric CMK outside of AWS KMS. For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS 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 customer master key (CMK). 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 CMK with a KeyUsage value of SIGN_VERIFY. To get the KeyUsage value of a CMK, use the DescribeKey operation. The caller must have kms:Sign permission on the CMK.
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 CMK.

When signing a message, be sure to record the CMK and the signing algorithm. This information is required to verify 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 AWS KMS.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Parameter Syntax

$result = $client->sign([
    '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', // REQUIRED
]);

Parameter Details

Members

GrantTokens

Type: Array of strings

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

KeyId

Required: Yes
Type: string

Identifies an asymmetric CMK. AWS KMS uses the private key in the asymmetric CMK to sign the message. The KeyUsage type of the CMK must be SIGN_VERIFY. To find the KeyUsage of a CMK, 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 CMK, 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 the message digest.

If you provide a message, AWS KMS generates a hash digest of the message and then signs it.

MessageType

Type: string

Tells AWS KMS whether the value of the Message parameter is a message or message digest. To indicate a message, enter RAW. To indicate a message digest, enter DIGEST.

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

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',
]

Result Details

Members

KeyId

Type: string

The Amazon Resource Name (ARN) of the asymmetric CMK 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.

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 CMK is not enabled.
KeyUnavailableException:
The request was rejected because the specified CMK was not available. You can retry the request.
DependencyTimeoutException:
The system timed out while trying to fulfill the request. The request can be retried.
InvalidKeyUsageException:
The request was rejected for one of the following reasons:
- The KeyUsage value of the CMK 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 CMK (CustomerMasterKeySpec).
For encrypting, decrypting, re-encrypting, and generating data keys, the KeyUsage must be ENCRYPT_DECRYPT. For signing and verifying, the KeyUsage must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation.

To find the encryption or signing algorithms supported for a particular CMK, 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.

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

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds or edits tags for a customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.

Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.

You can only use a tag key once for each CMK. If you use the tag key again, AWS KMS replaces the current tag value with the specified value.

For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Parameter Syntax

$result = $client->tagResource([
    'KeyId' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'TagKey' => '<string>', // REQUIRED
            'TagValue' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

KeyId

Required: Yes
Type: string

A unique identifier for the CMK you are tagging.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

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

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.

For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide .
LimitExceededException:
The request was rejected because a quota was exceeded. For more information, see Quotas in the AWS Key Management Service Developer Guide.
TagException:
The request was rejected because one or more tags are not valid.

Examples

Example 1: To tag a customer master key (CMK)

The following example tags a CMK.

$result = $client->tagResource([
    'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab', // The identifier of the CMK you are tagging. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
    'Tags' => [
        [
            'TagKey' => 'Purpose',
            'TagValue' => 'Test',
        ],
    ], // A list of tags.
]);

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes the specified tags from the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.

To remove a tag, specify the tag key. To change the tag value of an existing tag key, use TagResource.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Parameter Syntax

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

Parameter Details

Members

KeyId

Required: Yes
Type: string

A unique identifier for the CMK from which you are removing tags.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

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

For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide .
TagException:
The request was rejected because one or more tags are not valid.

Examples

Example 1: To remove tags from a customer master key (CMK)

The following example removes tags from a CMK.

$result = $client->untagResource([
    'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab', // The identifier of the CMK 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 AWS KMS alias with a different customer master key (CMK). Each alias is associated with only one CMK at a time, although a CMK can have multiple aliases. The alias and the CMK must be in the same AWS account and region. You cannot perform this operation on an alias in a different AWS account.

The current and new CMK must be the same type (both symmetric or both asymmetric), and they must have the same key usage (ENCRYPT_DECRYPT or SIGN_VERIFY). This restriction prevents errors in code that uses aliases. If you must assign an alias to a different type of CMK, 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 CMK, you can create, update, and delete the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs in the account, use the ListAliases operation.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

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 CMK. This value must begin with alias/ followed by the alias name, such as alias/ExampleAlias. You cannot use UpdateAlias to change the alias name.

TargetKeyId

Required: Yes
Type: string

Identifies the CMK to associate with the alias. When the update operation completes, the alias will point to this CMK.

The CMK must be in the same AWS account and Region as the alias. Also, the new target CMK must be the same type as the current target CMK (both symmetric or both asymmetric) and they must have the same key usage.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

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 CMK, use ListKeys or DescribeKey.

To verify that the alias is mapped to the correct CMK, 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. The request can be retried.
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.

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

Examples

Example 1: To update an alias

The following example updates the specified alias to refer to the specified customer master key (CMK).

$result = $client->updateAlias([
    'AliasName' => 'alias/ExampleAlias', // The alias to update.
    'TargetKeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab', // The identifier of the CMK that the alias will refer to after this operation succeeds. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
]);

UpdateCustomKeyStore

$result = $client->updateCustomKeyStore([/* ... */]);
$promise = $client->updateCustomKeyStoreAsync([/* ... */]);

Changes the properties of a custom key store. Use the CustomKeyStoreId parameter to identify the custom key store you want to edit. Use the remaining parameters to change the properties of the custom key store.

You can only update a custom key store that is disconnected. To disconnect the custom key store, use DisconnectCustomKeyStore. To reconnect the custom key store after the update completes, use ConnectCustomKeyStore. To find the connection state of a custom key store, use the DescribeCustomKeyStores operation.

Use the parameters of UpdateCustomKeyStore to edit your keystore settings.

Use the NewCustomKeyStoreName parameter to change the friendly name of the custom key store to the value that you specify.
Use the KeyStorePassword parameter tell AWS KMS the current password of the kmsuser crypto user (CU) in the associated AWS CloudHSM cluster. You can use this parameter to fix connection failures that occur when AWS KMS cannot log into the associated cluster because the kmsuser password has changed. This value does not change the password in the AWS CloudHSM cluster.
Use the CloudHsmClusterId parameter to associate the custom key store with a different, but related, AWS CloudHSM cluster. You can use this parameter to repair a custom key store if its AWS CloudHSM cluster becomes corrupted or is deleted, or when you need to create or restore a cluster from a backup.

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

Parameter Syntax

$result = $client->updateCustomKeyStore([
    'CloudHsmClusterId' => '<string>',
    'CustomKeyStoreId' => '<string>', // REQUIRED
    'KeyStorePassword' => '<string>',
    'NewCustomKeyStoreName' => '<string>',
]);

Parameter Details

Members

CloudHsmClusterId

Type: string

Associates the custom key store with a related AWS CloudHSM cluster.

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.

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 AWS CloudHSM cluster that is associated with the custom key store.

This parameter tells AWS KMS the current password of the kmsuser crypto user (CU). It does not set or change the password of any users in the AWS CloudHSM cluster.

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

CustomKeyStoreNotFoundException:
The request was rejected because AWS 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 AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID. Retry the request with a different cluster ID.
CloudHsmClusterNotRelatedException:
The request was rejected because the specified AWS CloudHSM cluster has a different cluster certificate than the original cluster. You cannot use the operation to specify an unrelated cluster.

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

Clusters that share a backup history have the same cluster certificate. To view the cluster certificate of a 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 CreateKey or GenerateRandom operation in a custom key store that is not connected. These operations are valid only when the custom key store ConnectionState is CONNECTED.
- 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 ConnectCustomKeyStore operation on a custom key store with a ConnectionState of DISCONNECTING or FAILED. This operation is valid for all other ConnectionState values.
KMSInternalException:
The request was rejected because an internal exception occurred. The request can be retried.
CloudHsmClusterNotActiveException:
The request was rejected because the AWS CloudHSM cluster that is associated with the custom key store is not active. Initialize and activate the cluster and try the command again. For detailed instructions, see Getting Started in the AWS CloudHSM User Guide.
CloudHsmClusterInvalidConfigurationException:
The request was rejected because the associated AWS CloudHSM cluster did not meet the configuration requirements for a custom key store.
- The 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 cluster. Do not delete or change them. To get information about a particular security group, use the DescribeSecurityGroups operation.
- The cluster must contain at least as many HSMs as the operation requires. To add HSMs, use the AWS CloudHSM CreateHsm operation.
  
  For the CreateCustomKeyStore, UpdateCustomKeyStore, and CreateKey operations, the AWS CloudHSM cluster must have at least two active HSMs, each in a different Availability Zone. For the ConnectCustomKeyStore operation, the AWS CloudHSM must contain at least one active HSM.
For information about the requirements for an AWS CloudHSM cluster that is associated with a custom key store, see Assemble the Prerequisites in the AWS Key Management Service Developer Guide. For information about creating a private subnet for an AWS CloudHSM cluster, see Create a Private Subnet in the AWS CloudHSM User Guide. For information about cluster security groups, see Configure a Default Security Group in the AWS CloudHSM User Guide .

UpdateKeyDescription

$result = $client->updateKeyDescription([/* ... */]);
$promise = $client->updateKeyDescriptionAsync([/* ... */]);

Updates the description of a customer master key (CMK). To see the description of a CMK, use DescribeKey.

You cannot perform this operation on a CMK in a different AWS account.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Parameter Syntax

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

Parameter Details

Members

Description

Required: Yes
Type: string

New description for the CMK.

KeyId

Required: Yes
Type: string

A unique identifier for the customer master key (CMK).

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

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 CMK, 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. The request can be retried.
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.

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

Examples

Example 1: To update the description of a customer master key (CMK)

The following example updates the description of the specified CMK.

$result = $client->updateKeyDescription([
    'Description' => 'Example description that indicates the intended use of this CMK.', // The updated description.
    'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab', // The identifier of the CMK whose description you are updating. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.
]);

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 CMK 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 CMK. The signature is verified by using the public key in the same asymmetric CMK. For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.

To verify a digital signature, you can use the Verify operation. Specify the same asymmetric CMK, message, and signing algorithm that were used to produce the signature.

You can also verify the digital signature by using the public key of the CMK outside of AWS KMS. Use the GetPublicKey operation to download the public key in the asymmetric CMK and then use the public key to verify the signature outside of AWS KMS. The advantage of using the Verify operation is that it is performed within AWS KMS. As a result, it's easy to call, the operation is performed within the FIPS boundary, it is logged in AWS CloudTrail, and you can use key policy and IAM policy to determine who is authorized to use the CMK to verify signatures.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Parameter Syntax

$result = $client->verify([
    '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', // REQUIRED
]);

Parameter Details

Members

GrantTokens

Type: Array of strings

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

KeyId

Required: Yes
Type: string

Identifies the asymmetric CMK that will be used to verify the signature. This must be the same CMK that was used to generate the signature. If you specify a different CMK, 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 CMK, 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 AWS KMS whether the value of the Message parameter is a message or message digest. The default value, RAW, indicates a message. To indicate a message digest, enter DIGEST.

Use the DIGEST value only when the value of the Message parameter is a message digest. If you use the DIGEST value with a raw message, the security of the verification operation can be compromised.

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',
]

Result Details

Members

KeyId

Type: string

The unique identifier for the asymmetric CMK 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 CMK is not enabled.
KeyUnavailableException:
The request was rejected because the specified CMK was not available. You can retry the request.
DependencyTimeoutException:
The system timed out while trying to fulfill the request. The request can be retried.
InvalidKeyUsageException:
The request was rejected for one of the following reasons:
- The KeyUsage value of the CMK 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 CMK (CustomerMasterKeySpec).
For encrypting, decrypting, re-encrypting, and generating data keys, the KeyUsage must be ENCRYPT_DECRYPT. For signing and verifying, the KeyUsage must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation.

To find the encryption or signing algorithms supported for a particular CMK, 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.

For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide .
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 CMK and signing algorithm.

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

TargetKeyId

Type: string

String that contains the key identifier referred to by 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 AWS CloudHSM cluster is already associated with a custom key store or it shares a backup history with a cluster that is associated with a custom key store. Each custom key store must be associated with a different AWS CloudHSM cluster.

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

Members

message

Type: string

CloudHsmClusterInvalidConfigurationException

Description

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

The 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 cluster. Do not delete or change them. To get information about a particular security group, use the DescribeSecurityGroups operation.
The cluster must contain at least as many HSMs as the operation requires. To add HSMs, use the AWS CloudHSM CreateHsm operation.

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

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

Members

message

Type: string

CloudHsmClusterNotActiveException

Description

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

Members

message

Type: string

CloudHsmClusterNotFoundException

Description

The request was rejected because AWS KMS cannot find the AWS 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 AWS CloudHSM cluster has a different cluster certificate than the original cluster. You cannot use the operation to specify an unrelated cluster.

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

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

Members

message

Type: string

CustomKeyStoreHasCMKsException

Description

The request was rejected because the custom key store contains AWS KMS customer master keys (CMKs). After verifying that you do not need to use the CMKs, use the ScheduleKeyDeletion operation to delete the CMKs. 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 CreateKey or GenerateRandom operation in a custom key store that is not connected. These operations are valid only when the custom key store ConnectionState is CONNECTED.
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 ConnectCustomKeyStore operation on a custom key store with a ConnectionState of DISCONNECTING or FAILED. This operation is valid for all other ConnectionState values.

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 AWS 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 AWS CloudHSM cluster that is associated with the custom key store.

ConnectionErrorCode

Type: string

Describes the connection error. This field appears in the response only when the ConnectionState is FAILED. For help resolving these errors, see How to Fix a Connection Failure in AWS Key Management Service Developer Guide.

Valid values are:

CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.
INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.
INTERNAL_ERROR - AWS 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.
INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.
NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store.
USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS 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 the associated AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its AWS 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 AWS Key Management Service Developer Guide.
USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS CloudHSM cluster. Before you can connect your custom key store to its AWS 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.

ConnectionState

Type: string

Indicates whether the custom key store is connected to its AWS CloudHSM cluster.

You can create and use CMKs in your custom key stores only when its connection state is CONNECTED.

The value is DISCONNECTED 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 its associated AWS CloudHSM cluster is active and contains at least one active HSM.

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

TrustAnchorCertificate

Type: string

Type: string

GrantConstraints

Description

Use this structure to allow cryptographic operations in the grant only when the operation request includes the specified encryption context.

AWS KMS applies the grant constraints only when the grant allows a cryptographic operation that accepts an encryption context as input, such as the following.

Encrypt
Decrypt
GenerateDataKey
GenerateDataKeyWithoutPlaintext
ReEncrypt

AWS KMS does not apply the grant constraints to other operations, such as DescribeKey or ScheduleKeyDeletion.

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 AWS 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 an entry in a list of grants.

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 principal that receives the grant's permissions.

IssuingAccount

Type: string

The AWS account under which the grant was issued.

KeyId

Type: string

The unique identifier for the customer master key (CMK) 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 CMK cannot decrypt the data. The KeyId in a Decrypt request and the SourceKeyId in a ReEncrypt request must identify the same CMK 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 customer master key (CMK).

Members

message

Type: string

IncorrectTrustAnchorException

Description

The request was rejected because the trust anchor certificate in the request is not the trust anchor certificate for the specified AWS CloudHSM cluster.

When you initialize the 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 AWS 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 customer master key (CMK).

Members

message

Type: string

InvalidKeyUsageException

Description

The request was rejected for one of the following reasons:

The KeyUsage value of the CMK 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 CMK (CustomerMasterKeySpec).

For encrypting, decrypting, re-encrypting, and generating data keys, the KeyUsage must be ENCRYPT_DECRYPT. For signing and verifying, the KeyUsage must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation.

To find the encryption or signing algorithms supported for a particular CMK, 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

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

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

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 customer master key (CMK).

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

Members

AWSAccountId

Type: string

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

Arn

Type: string

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

CloudHsmClusterId

Type: string

The cluster ID of the AWS CloudHSM cluster that contains the key material for the CMK. When you create a CMK in a custom key store, AWS KMS creates the key material for the CMK in the associated AWS CloudHSM cluster. This value is present only when the CMK is created in a custom key store.

CreationDate

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

The date and time when the CMK was created.

CustomKeyStoreId

Type: string

A unique identifier for the custom key store that contains the CMK. This value is present only when the CMK is created in a custom key store.

CustomerMasterKeySpec

Type: string

Describes the type of key material in the CMK.

DeletionDate

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

The date and time after which AWS KMS deletes the CMK. This value is present only when KeyState is PendingDeletion.

Description

Type: string

The description of the CMK.

Enabled

Type: boolean

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

EncryptionAlgorithms

Type: Array of strings

A list of encryption algorithms that the CMK supports. You cannot use the CMK with other encryption algorithms within AWS KMS.

This field appears only when the KeyUsage of the CMK is ENCRYPT_DECRYPT.

ExpirationModel

Type: string

Specifies whether the CMK'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 CMK.

KeyManager

Type: string

The manager of the CMK. CMKs in your AWS account are either customer managed or AWS managed. For more information about the difference, see Customer Master Keys in the AWS Key Management Service Developer Guide.

KeyState

Type: string

The state of the CMK.

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

KeyUsage

Type: string

The cryptographic operations for which you can use the CMK.

Origin

Type: string

The source of the CMK's key material. When this value is AWS_KMS, AWS KMS created the key material. When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the CMK lacks key material. When this value is AWS_CLOUDHSM, the key material was created in the AWS CloudHSM cluster associated with a custom key store.

SigningAlgorithms

Type: Array of strings

A list of signing algorithms that the CMK supports. You cannot use the CMK with other signing algorithms within AWS KMS.

This field appears only when the KeyUsage of the CMK is SIGN_VERIFY.

ValidTo

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

Type: string

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 customer master key (CMK)

ConnectCustomKeyStore

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

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

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 customer master key (CMK)

Decrypt

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To decrypt data

DeleteAlias

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details