AWS Key Management Service 2014-11-01

CancelKeyDeletion

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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 limit was exceeded. For more information, see Limits 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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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([/* ... */]);

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

Result Syntax

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

Result Details

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 limit was exceeded. For more information, see Limits 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([/* ... */]);

Parameter Syntax

$result = $client->createKey([
    'BypassPolicyLockoutSafetyCheck' => true || false,
    'CustomKeyStoreId' => '<string>',
    'Description' => '<string>',
    'KeyUsage' => 'ENCRYPT_DECRYPT',
    'Origin' => 'AWS_KMS|EXTERNAL|AWS_CLOUDHSM',
    'Policy' => '<string>',
    'Tags' => [
        [
            'TagKey' => '<string>', // REQUIRED
            'TagValue' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'KeyMetadata' => [
        'AWSAccountId' => '<string>',
        'Arn' => '<string>',
        'CloudHsmClusterId' => '<string>',
        'CreationDate' => <DateTime>,
        'CustomKeyStoreId' => '<string>',
        'DeletionDate' => <DateTime>,
        'Description' => '<string>',
        'Enabled' => true || false,
        'ExpirationModel' => 'KEY_MATERIAL_EXPIRES|KEY_MATERIAL_DOES_NOT_EXPIRE',
        'KeyId' => '<string>',
        'KeyManager' => 'AWS|CUSTOMER',
        'KeyState' => 'Enabled|Disabled|PendingDeletion|PendingImport|Unavailable',
        'KeyUsage' => 'ENCRYPT_DECRYPT',
        'Origin' => 'AWS_KMS|EXTERNAL|AWS_CLOUDHSM',
        'ValidTo' => <DateTime>,
    ],
]

Result Details

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 limit was exceeded. For more information, see Limits 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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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:

  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.

• KeyUnavailableException:

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

• 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' => , // 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' => , // The decrypted (plaintext) data.
]

DeleteAlias

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'CustomKeyStores' => [
        [
            'CloudHsmClusterId' => '<string>',
            'ConnectionErrorCode' => 'INVALID_CREDENTIALS|CLUSTER_NOT_FOUND|NETWORK_ERRORS|INTERNAL_ERROR|INSUFFICIENT_CLOUDHSM_HSMS|USER_LOCKED_OUT',
            'ConnectionState' => 'CONNECTED|CONNECTING|FAILED|DISCONNECTED|DISCONNECTING',
            'CreationDate' => <DateTime>,
            'CustomKeyStoreId' => '<string>',
            'CustomKeyStoreName' => '<string>',
            'TrustAnchorCertificate' => '<string>',
        ],
        // ...
    ],
    'NextMarker' => '<string>',
    'Truncated' => true || false,
]

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'KeyMetadata' => [
        'AWSAccountId' => '<string>',
        'Arn' => '<string>',
        'CloudHsmClusterId' => '<string>',
        'CreationDate' => <DateTime>,
        'CustomKeyStoreId' => '<string>',
        'DeletionDate' => <DateTime>,
        'Description' => '<string>',
        'Enabled' => true || false,
        'ExpirationModel' => 'KEY_MATERIAL_EXPIRES|KEY_MATERIAL_DOES_NOT_EXPIRE',
        'KeyId' => '<string>',
        'KeyManager' => 'AWS|CUSTOMER',
        'KeyState' => 'Enabled|Disabled|PendingDeletion|PendingImport|Unavailable',
        'KeyUsage' => 'ENCRYPT_DECRYPT',
        'Origin' => 'AWS_KMS|EXTERNAL|AWS_CLOUDHSM',
        'ValidTo' => <DateTime>,
    ],
]

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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 limit was exceeded. For more information, see Limits 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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

• DependencyTimeoutException:

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

• InvalidKeyUsageException:

  The request was rejected because the specified KeySpec value is not valid.

• 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' => , // The data to encrypt.
]);

Result syntax:

[
    'CiphertextBlob' => , // 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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

• DependencyTimeoutException:

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

• InvalidKeyUsageException:

  The request was rejected because the specified KeySpec value is not valid.

• 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' => , // 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' => , // The unencrypted (plaintext) data key.
]

GenerateDataKeyWithoutPlaintext

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

• DependencyTimeoutException:

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

• InvalidKeyUsageException:

  The request was rejected because the specified KeySpec value is not valid.

• 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' => , // 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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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' => , // The random data.
]

GetKeyPolicy

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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([/* ... */]);

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

Result Syntax

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

Result Details

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' => , // 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' => , // The public key to use to encrypt the key material before importing it.
]

ImportKeyMaterial

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

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

Result Syntax

[]

Result Details

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:

  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.

• IncorrectKeyMaterialException:

  The request was rejected because the provided key material is 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 provided 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' => , // The encrypted key material to import.
    'ExpirationModel' => 'KEY_MATERIAL_DOES_NOT_EXPIRE', // A value that specifies whether the key material expires.
    'ImportToken' => , // 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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details

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

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details

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

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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 limit was exceeded. For more information, see Limits 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([/* ... */]);

Parameter Syntax

$result = $client->reEncrypt([
    'CiphertextBlob' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
    'DestinationEncryptionContext' => ['<string>', ...],
    'DestinationKeyId' => '<string>', // REQUIRED
    'GrantTokens' => ['<string>', ...],
    'SourceEncryptionContext' => ['<string>', ...],
]);

Parameter Details

Result Syntax

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

Result Details

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:

  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.

• KeyUnavailableException:

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

• DependencyTimeoutException:

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

• InvalidKeyUsageException:

  The request was rejected because the specified KeySpec value is not valid.

• 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' => , // 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' => , // 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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

TagResource

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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 limit was exceeded. For more information, see Limits 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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• CustomKeyStoreNotFoundException:

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

• 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([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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