AWSKMS
Objective-C
@interface AWSKMS
Swift
class AWSKMS
AWS Key Management Service (AWS KMS) is an encryption and key management web service. This guide describes the AWS KMS operations that you can call programmatically. For general information about AWS KMS, see the AWS Key Management Service Developer Guide.
AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, macOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWS KMS and other AWS services. For example, the SDKs take care of tasks such as signing requests (see below), managing errors, and retrying requests automatically. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.
We recommend that you use the AWS SDKs to make programmatic API calls to AWS KMS.
Clients must support TLS (Transport Layer Security) 1.0. We recommend TLS 1.2. Clients must also support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems such as Java 7 and later support these modes.
Signing Requests
Requests must be signed by using an access key ID and a secret access key. We strongly recommend that you do not use your AWS account (root) access key ID and secret key for everyday work with AWS KMS. Instead, use the access key ID and secret access key for an IAM user. You can also use the AWS Security Token Service to generate temporary security credentials that you can use to sign requests.
All AWS KMS operations require Signature Version 4.
Logging API Requests
AWS KMS supports AWS CloudTrail, a service that logs AWS API calls and related events for your AWS account and delivers them to an Amazon S3 bucket that you specify. By using the information collected by CloudTrail, you can determine what requests were made to AWS KMS, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide.
Additional Resources
For more information about credentials and request signing, see the following:
AWS Security Credentials - This topic provides general information about the types of credentials used for accessing AWS.
Temporary Security Credentials - This section of the IAM User Guide describes how to create and use temporary security credentials.
Signature Version 4 Signing Process - This set of topics walks you through the process of signing a request using an access key ID and a secret access key.
Commonly Used API Operations
Of the API operations discussed in this guide, the following will prove the most useful for most applications. You will likely perform operations other than these, such as creating keys and assigning policies, by using the console.
-
The service configuration used to instantiate this service client.
Warning
Once the client is instantiated, do not modify the configuration object. It may cause unspecified behaviors.Declaration
Objective-C
@property (nonatomic, strong, readonly) AWSServiceConfiguration *configuration
Swift
var configuration: UnsafeMutablePointer<Int32> { get }
-
Returns the singleton service client. If the singleton object does not exist, the SDK instantiates the default service client with
defaultServiceConfiguration
from[AWSServiceManager defaultServiceManager]
. The reference to this object is maintained by the SDK, and you do not need to retain it manually.For example, set the default service configuration in
- application:didFinishLaunchingWithOptions:
Swift
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool { let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId") let configuration = AWSServiceConfiguration(region: .USEast1, credentialsProvider: credentialProvider) AWSServiceManager.default().defaultServiceConfiguration = configuration return true
}
Objective-C
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 identityPoolId:@"YourIdentityPoolId"]; AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSEast1 credentialsProvider:credentialsProvider]; [AWSServiceManager defaultServiceManager].defaultServiceConfiguration = configuration; return YES; }
Then call the following to get the default service client:
Swift
let KMS = AWSKMS.default()
Objective-C
AWSKMS *KMS = [AWSKMS defaultKMS];
Declaration
Objective-C
+ (nonnull instancetype)defaultKMS;
Swift
class func `default`() -> Self
Return Value
The default service client.
-
Creates a service client with the given service configuration and registers it for the key.
For example, set the default service configuration in
- application:didFinishLaunchingWithOptions:
Swift
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool { let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId") let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider) AWSKMS.register(with: configuration!, forKey: "USWest2KMS") return true
}
Objective-C
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 identityPoolId:@"YourIdentityPoolId"]; AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2 credentialsProvider:credentialsProvider]; [AWSKMS registerKMSWithConfiguration:configuration forKey:@"USWest2KMS"]; return YES; }
Then call the following to get the service client:
Swift
let KMS = AWSKMS(forKey: "USWest2KMS")
Objective-C
AWSKMS *KMS = [AWSKMS KMSForKey:@"USWest2KMS"];
Warning
After calling this method, do not modify the configuration object. It may cause unspecified behaviors.
Declaration
Objective-C
+ (void)registerKMSWithConfiguration:(id)configuration forKey:(nonnull NSString *)key;
Swift
class func register(withConfiguration configuration: Any!, forKey key: String)
Parameters
configuration
A service configuration object.
key
A string to identify the service client.
-
Retrieves the service client associated with the key. You need to call
+ registerKMSWithConfiguration:forKey:
before invoking this method.For example, set the default service configuration in
- application:didFinishLaunchingWithOptions:
Swift
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool { let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId") let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider) AWSKMS.register(with: configuration!, forKey: "USWest2KMS") return true
}
Objective-C
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 identityPoolId:@"YourIdentityPoolId"]; AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2 credentialsProvider:credentialsProvider]; [AWSKMS registerKMSWithConfiguration:configuration forKey:@"USWest2KMS"]; return YES; }
Then call the following to get the service client:
Swift
let KMS = AWSKMS(forKey: "USWest2KMS")
Objective-C
AWSKMS *KMS = [AWSKMS KMSForKey:@"USWest2KMS"];
Declaration
Objective-C
+ (nonnull instancetype)KMSForKey:(nonnull NSString *)key;
Swift
convenience init(forKey key: String)
Parameters
key
A string to identify the service client.
Return Value
An instance of the service client.
-
Removes the service client associated with the key and release it.
Warning
Before calling this method, make sure no method is running on this client.
Declaration
Objective-C
+ (void)removeKMSForKey:(nonnull NSString *)key;
Swift
class func remove(forKey key: String)
Parameters
key
A string to identify the service client.
-
Cancels the deletion of a customer master key (CMK). When this operation succeeds, the key state of the CMK is
Disabled
. To enable the CMK, use EnableKey.For more information about scheduling and canceling deletion of a CMK, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.
Required permissions: kms:CancelKeyDeletion (key policy)
Related operations: ScheduleKeyDeletion
See
AWSKMSCancelKeyDeletionRequest
See
AWSKMSCancelKeyDeletionResponse
Declaration
Objective-C
- (id)cancelKeyDeletion:(nonnull AWSKMSCancelKeyDeletionRequest *)request;
Swift
func cancelKeyDeletion(_ request: AWSKMSCancelKeyDeletionRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CancelKeyDeletion service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSKMSCancelKeyDeletionResponse
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorInvalidArn
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
. -
Cancels the deletion of a customer master key (CMK). When this operation succeeds, the key state of the CMK is
Disabled
. To enable the CMK, use EnableKey.For more information about scheduling and canceling deletion of a CMK, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.
Required permissions: kms:CancelKeyDeletion (key policy)
Related operations: ScheduleKeyDeletion
See
AWSKMSCancelKeyDeletionRequest
See
AWSKMSCancelKeyDeletionResponse
Declaration
Objective-C
- (void)cancelKeyDeletion:(nonnull AWSKMSCancelKeyDeletionRequest *)request completionHandler: (void (^_Nullable)(AWSKMSCancelKeyDeletionResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func cancelKeyDeletion(_ request: AWSKMSCancelKeyDeletionRequest, completionHandler: ((AWSKMSCancelKeyDeletionResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the CancelKeyDeletion service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorInvalidArn
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
. -
Connects or reconnects a custom key store to its associated AWS CloudHSM cluster.
The custom key store must be connected before you can create customer master keys (CMKs) in the key store or use the CMKs it contains. You can disconnect and reconnect a custom key store at any time.
To connect a custom key store, its associated AWS CloudHSM cluster must have at least one active HSM. To get the number of active HSMs in a cluster, use the DescribeClusters operation. To add HSMs to the cluster, use the CreateHsm operation. Also, the
kmsuser
crypto user (CU) must not be logged into the cluster. This prevents AWS KMS from using this account to log in.The connection process can take an extended amount of time to complete; up to 20 minutes. This operation starts the connection process, but it does not wait for it to complete. When it succeeds, this operation quickly returns an HTTP 200 response and a JSON object with no properties. However, this response does not indicate that the custom key store is connected. To get the connection state of the custom key store, use the DescribeCustomKeyStores operation.
During the connection process, AWS KMS finds the AWS CloudHSM cluster that is associated with the custom key store, creates the connection infrastructure, connects to the cluster, logs into the AWS CloudHSM client as the
kmsuser
CU, and rotates its password.The
ConnectCustomKeyStore
operation might fail for various reasons. To find the reason, use the DescribeCustomKeyStores operation and see theConnectionErrorCode
in the response. For help interpreting theConnectionErrorCode
, see CustomKeyStoresListEntry.To fix the failure, use the DisconnectCustomKeyStore operation to disconnect the custom key store, correct the error, use the UpdateCustomKeyStore operation if necessary, and then use
ConnectCustomKeyStore
again.If you are having trouble connecting or disconnecting a custom key store, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a custom key store in a different AWS account.
Required permissions: kms:ConnectCustomKeyStore (IAM policy)
Related operations
See
AWSKMSConnectCustomKeyStoreRequest
See
AWSKMSConnectCustomKeyStoreResponse
Declaration
Objective-C
- (id)connectCustomKeyStore: (nonnull AWSKMSConnectCustomKeyStoreRequest *)request;
Swift
func connectCustomKeyStore(_ request: AWSKMSConnectCustomKeyStoreRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the ConnectCustomKeyStore service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSKMSConnectCustomKeyStoreResponse
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorCloudHsmClusterNotActive
,AWSKMSErrorCustomKeyStoreInvalidState
,AWSKMSErrorCustomKeyStoreNotFound
,AWSKMSErrorKMSInternal
,AWSKMSErrorCloudHsmClusterInvalidConfiguration
. -
Connects or reconnects a custom key store to its associated AWS CloudHSM cluster.
The custom key store must be connected before you can create customer master keys (CMKs) in the key store or use the CMKs it contains. You can disconnect and reconnect a custom key store at any time.
To connect a custom key store, its associated AWS CloudHSM cluster must have at least one active HSM. To get the number of active HSMs in a cluster, use the DescribeClusters operation. To add HSMs to the cluster, use the CreateHsm operation. Also, the
kmsuser
crypto user (CU) must not be logged into the cluster. This prevents AWS KMS from using this account to log in.The connection process can take an extended amount of time to complete; up to 20 minutes. This operation starts the connection process, but it does not wait for it to complete. When it succeeds, this operation quickly returns an HTTP 200 response and a JSON object with no properties. However, this response does not indicate that the custom key store is connected. To get the connection state of the custom key store, use the DescribeCustomKeyStores operation.
During the connection process, AWS KMS finds the AWS CloudHSM cluster that is associated with the custom key store, creates the connection infrastructure, connects to the cluster, logs into the AWS CloudHSM client as the
kmsuser
CU, and rotates its password.The
ConnectCustomKeyStore
operation might fail for various reasons. To find the reason, use the DescribeCustomKeyStores operation and see theConnectionErrorCode
in the response. For help interpreting theConnectionErrorCode
, see CustomKeyStoresListEntry.To fix the failure, use the DisconnectCustomKeyStore operation to disconnect the custom key store, correct the error, use the UpdateCustomKeyStore operation if necessary, and then use
ConnectCustomKeyStore
again.If you are having trouble connecting or disconnecting a custom key store, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a custom key store in a different AWS account.
Required permissions: kms:ConnectCustomKeyStore (IAM policy)
Related operations
See
AWSKMSConnectCustomKeyStoreRequest
See
AWSKMSConnectCustomKeyStoreResponse
Declaration
Objective-C
- (void) connectCustomKeyStore:(nonnull AWSKMSConnectCustomKeyStoreRequest *)request completionHandler: (void (^_Nullable)(AWSKMSConnectCustomKeyStoreResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func connectCustomKeyStore(_ request: AWSKMSConnectCustomKeyStoreRequest, completionHandler: ((AWSKMSConnectCustomKeyStoreResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the ConnectCustomKeyStore service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorCloudHsmClusterNotActive
,AWSKMSErrorCustomKeyStoreInvalidState
,AWSKMSErrorCustomKeyStoreNotFound
,AWSKMSErrorKMSInternal
,AWSKMSErrorCloudHsmClusterInvalidConfiguration
. -
Creates a friendly name for a customer master key (CMK). You can use an alias to identify a CMK in the AWS KMS console, in the DescribeKey operation and in cryptographic operations, such as Encrypt and GenerateDataKey.
You can also change the CMK that’s associated with the alias (UpdateAlias) or delete the alias (DeleteAlias) at any time. These operations don’t affect the underlying CMK.
You can associate the alias with any customer managed CMK in the same AWS Region. Each alias is associated with only on CMK at a time, but a CMK can have multiple aliases. A valid CMK is required. You can’t create an alias without a CMK.
The alias must be unique in the account and Region, but you can have aliases with the same name in different Regions. For detailed information about aliases, see Using aliases in the AWS Key Management Service Developer Guide.
This operation does not return a response. To get the alias that you created, use the ListAliases operation.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on an alias in a different AWS account.
Required permissions
kms:CreateAlias on the alias (IAM policy).
kms:CreateAlias on the CMK (key policy).
For details, see Controlling access to aliases in the AWS Key Management Service Developer Guide.
Related operations:
See
AWSKMSCreateAliasRequest
Declaration
Objective-C
- (id)createAlias:(nonnull AWSKMSCreateAliasRequest *)request;
Swift
func createAlias(_ request: AWSKMSCreateAliasRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CreateAlias service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorDependencyTimeout
,AWSKMSErrorAlreadyExists
,AWSKMSErrorNotFound
,AWSKMSErrorInvalidAliasName
,AWSKMSErrorKMSInternal
,AWSKMSErrorLimitExceeded
,AWSKMSErrorKMSInvalidState
. -
Creates a friendly name for a customer master key (CMK). You can use an alias to identify a CMK in the AWS KMS console, in the DescribeKey operation and in cryptographic operations, such as Encrypt and GenerateDataKey.
You can also change the CMK that’s associated with the alias (UpdateAlias) or delete the alias (DeleteAlias) at any time. These operations don’t affect the underlying CMK.
You can associate the alias with any customer managed CMK in the same AWS Region. Each alias is associated with only on CMK at a time, but a CMK can have multiple aliases. A valid CMK is required. You can’t create an alias without a CMK.
The alias must be unique in the account and Region, but you can have aliases with the same name in different Regions. For detailed information about aliases, see Using aliases in the AWS Key Management Service Developer Guide.
This operation does not return a response. To get the alias that you created, use the ListAliases operation.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on an alias in a different AWS account.
Required permissions
kms:CreateAlias on the alias (IAM policy).
kms:CreateAlias on the CMK (key policy).
For details, see Controlling access to aliases in the AWS Key Management Service Developer Guide.
Related operations:
See
AWSKMSCreateAliasRequest
Declaration
Objective-C
- (void)createAlias:(nonnull AWSKMSCreateAliasRequest *)request completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func createAlias(_ request: AWSKMSCreateAliasRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the CreateAlias service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorDependencyTimeout
,AWSKMSErrorAlreadyExists
,AWSKMSErrorNotFound
,AWSKMSErrorInvalidAliasName
,AWSKMSErrorKMSInternal
,AWSKMSErrorLimitExceeded
,AWSKMSErrorKMSInvalidState
. -
Creates a custom key store that is associated with an AWS CloudHSM cluster that you own and manage.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
Before you create the custom key store, you must assemble the required elements, including an AWS CloudHSM cluster that fulfills the requirements for a custom key store. For details about the required elements, see Assemble the Prerequisites in the AWS Key Management Service Developer Guide.
When the operation completes successfully, it returns the ID of the new custom key store. Before you can use your new custom key store, you need to use the ConnectCustomKeyStore operation to connect the new key store to its AWS CloudHSM cluster. Even if you are not going to use your custom key store immediately, you might want to connect it to verify that all settings are correct and then disconnect it until you are ready to use it.
For help with failures, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a custom key store in a different AWS account.
Required permissions: kms:CreateCustomKeyStore (IAM policy).
Related operations:
See
AWSKMSCreateCustomKeyStoreRequest
See
AWSKMSCreateCustomKeyStoreResponse
Declaration
Objective-C
- (id)createCustomKeyStore:(nonnull AWSKMSCreateCustomKeyStoreRequest *)request;
Swift
func createCustomKeyStore(_ request: AWSKMSCreateCustomKeyStoreRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CreateCustomKeyStore service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSKMSCreateCustomKeyStoreResponse
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorCloudHsmClusterInUse
,AWSKMSErrorCustomKeyStoreNameInUse
,AWSKMSErrorCloudHsmClusterNotFound
,AWSKMSErrorKMSInternal
,AWSKMSErrorCloudHsmClusterNotActive
,AWSKMSErrorIncorrectTrustAnchor
,AWSKMSErrorCloudHsmClusterInvalidConfiguration
. -
Creates a custom key store that is associated with an AWS CloudHSM cluster that you own and manage.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
Before you create the custom key store, you must assemble the required elements, including an AWS CloudHSM cluster that fulfills the requirements for a custom key store. For details about the required elements, see Assemble the Prerequisites in the AWS Key Management Service Developer Guide.
When the operation completes successfully, it returns the ID of the new custom key store. Before you can use your new custom key store, you need to use the ConnectCustomKeyStore operation to connect the new key store to its AWS CloudHSM cluster. Even if you are not going to use your custom key store immediately, you might want to connect it to verify that all settings are correct and then disconnect it until you are ready to use it.
For help with failures, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a custom key store in a different AWS account.
Required permissions: kms:CreateCustomKeyStore (IAM policy).
Related operations:
See
AWSKMSCreateCustomKeyStoreRequest
See
AWSKMSCreateCustomKeyStoreResponse
Declaration
Objective-C
- (void)createCustomKeyStore: (nonnull AWSKMSCreateCustomKeyStoreRequest *)request completionHandler: (void (^_Nullable)(AWSKMSCreateCustomKeyStoreResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func createCustomKeyStore(_ request: AWSKMSCreateCustomKeyStoreRequest, completionHandler: ((AWSKMSCreateCustomKeyStoreResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the CreateCustomKeyStore service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorCloudHsmClusterInUse
,AWSKMSErrorCustomKeyStoreNameInUse
,AWSKMSErrorCloudHsmClusterNotFound
,AWSKMSErrorKMSInternal
,AWSKMSErrorCloudHsmClusterNotActive
,AWSKMSErrorIncorrectTrustAnchor
,AWSKMSErrorCloudHsmClusterInvalidConfiguration
. -
Adds a grant to a customer master key (CMK). The grant allows the grantee principal to use the CMK when the conditions specified in the grant are met. When setting permissions, grants are an alternative to key policies.
To create a grant that allows a cryptographic operation only when the request includes a particular encryption context, use the
Constraints
parameter. For details, see GrantConstraints.You can create grants on symmetric and asymmetric CMKs. However, if the grant allows an operation that the CMK does not support,
CreateGrant
fails with aValidationException
.Grants for symmetric CMKs cannot allow operations that are not supported for symmetric CMKs, including Sign, Verify, and GetPublicKey. (There are limited exceptions to this rule for legacy operations, but you should not create a grant for an operation that AWS KMS does not support.)
Grants for asymmetric CMKs cannot allow operations that are not supported for asymmetric CMKs, including operations that generate data keys or data key pairs, or operations related to automatic key rotation, imported key material, or CMKs in custom key stores.
Grants for asymmetric CMKs with a
KeyUsage
ofENCRYPT_DECRYPT
cannot allow the Sign or Verify operations. Grants for asymmetric CMKs with aKeyUsage
ofSIGN_VERIFY
cannot allow the Encrypt or Decrypt operations.Grants for asymmetric CMKs cannot include an encryption context grant constraint. An encryption context is not supported on asymmetric CMKs.
For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide. For more information about grants, see Grants in the AWS Key Management Service Developer Guide.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: Yes. To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the
KeyId
parameter.Required permissions: kms:CreateGrant (key policy)
Related operations:
See
AWSKMSCreateGrantRequest
See
AWSKMSCreateGrantResponse
Declaration
Objective-C
- (id)createGrant:(nonnull AWSKMSCreateGrantRequest *)request;
Swift
func createGrant(_ request: AWSKMSCreateGrantRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CreateGrant service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSKMSCreateGrantResponse
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorDisabled
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorInvalidArn
,AWSKMSErrorKMSInternal
,AWSKMSErrorInvalidGrantToken
,AWSKMSErrorLimitExceeded
,AWSKMSErrorKMSInvalidState
. -
Adds a grant to a customer master key (CMK). The grant allows the grantee principal to use the CMK when the conditions specified in the grant are met. When setting permissions, grants are an alternative to key policies.
To create a grant that allows a cryptographic operation only when the request includes a particular encryption context, use the
Constraints
parameter. For details, see GrantConstraints.You can create grants on symmetric and asymmetric CMKs. However, if the grant allows an operation that the CMK does not support,
CreateGrant
fails with aValidationException
.Grants for symmetric CMKs cannot allow operations that are not supported for symmetric CMKs, including Sign, Verify, and GetPublicKey. (There are limited exceptions to this rule for legacy operations, but you should not create a grant for an operation that AWS KMS does not support.)
Grants for asymmetric CMKs cannot allow operations that are not supported for asymmetric CMKs, including operations that generate data keys or data key pairs, or operations related to automatic key rotation, imported key material, or CMKs in custom key stores.
Grants for asymmetric CMKs with a
KeyUsage
ofENCRYPT_DECRYPT
cannot allow the Sign or Verify operations. Grants for asymmetric CMKs with aKeyUsage
ofSIGN_VERIFY
cannot allow the Encrypt or Decrypt operations.Grants for asymmetric CMKs cannot include an encryption context grant constraint. An encryption context is not supported on asymmetric CMKs.
For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide. For more information about grants, see Grants in the AWS Key Management Service Developer Guide.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: Yes. To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the
KeyId
parameter.Required permissions: kms:CreateGrant (key policy)
Related operations:
See
AWSKMSCreateGrantRequest
See
AWSKMSCreateGrantResponse
Declaration
Objective-C
- (void)createGrant:(nonnull AWSKMSCreateGrantRequest *)request completionHandler:(void (^_Nullable)(AWSKMSCreateGrantResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func createGrant(_ request: AWSKMSCreateGrantRequest, completionHandler: ((AWSKMSCreateGrantResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the CreateGrant service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorDisabled
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorInvalidArn
,AWSKMSErrorKMSInternal
,AWSKMSErrorInvalidGrantToken
,AWSKMSErrorLimitExceeded
,AWSKMSErrorKMSInvalidState
. -
Creates a unique customer managed customer master key (CMK) in your AWS account and Region.
You can use the
CreateKey
operation to create symmetric or asymmetric CMKs.Symmetric CMKs contain a 256-bit symmetric key that never leaves AWS KMS unencrypted. To use the CMK, you must call AWS KMS. You can use a symmetric CMK to encrypt and decrypt small amounts of data, but they are typically used to generate data keys and data keys pairs. For details, see GenerateDataKey and GenerateDataKeyPair.
Asymmetric CMKs can contain an RSA key pair or an Elliptic Curve (ECC) key pair. The private key in an asymmetric CMK never leaves AWS KMS unencrypted. However, you can use the GetPublicKey operation to download the public key so it can be used outside of AWS KMS. CMKs with RSA key pairs can be used to encrypt or decrypt data or sign and verify messages (but not both). CMKs with ECC key pairs can be used only to sign and verify messages.
For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
To create different types of CMKs, use the following guidance:
- Asymmetric CMKs
To create an asymmetric CMK, use the
CustomerMasterKeySpec
parameter to specify the type of key material in the CMK. Then, use theKeyUsage
parameter to determine whether the CMK will be used to encrypt and decrypt or sign and verify. You can’t change these properties after the CMK is created.- Symmetric CMKs
When creating a symmetric CMK, you don’t need to specify the
CustomerMasterKeySpec
orKeyUsage
parameters. The default value forCustomerMasterKeySpec
,SYMMETRIC_DEFAULT
, and the default value forKeyUsage
,ENCRYPT_DECRYPT
, are the only valid values for symmetric CMKs.- Imported Key Material
To import your own key material, begin by creating a symmetric CMK with no key material. To do this, use the
Origin
parameter ofCreateKey
with a value ofEXTERNAL
. Next, use GetParametersForImport operation to get a public key and import token, and use the public key to encrypt your key material. Then, use ImportKeyMaterial with your import token to import the key material. For step-by-step instructions, see Importing Key Material in the AWS Key Management Service Developer Guide. You cannot import the key material into an asymmetric CMK.- Custom Key Stores
To create a symmetric CMK in a custom key store, use the
CustomKeyStoreId
parameter to specify the custom key store. You must also use theOrigin
parameter with a value ofAWS_CLOUDHSM
. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs in different Availability Zones in the AWS Region.You cannot create an asymmetric CMK in a custom key store. For information about custom key stores in AWS KMS see Using Custom Key Stores in the AWS Key Management Service Developer Guide.
Cross-account use: No. You cannot use this operation to create a CMK in a different AWS account.
Required permissions: kms:CreateKey (IAM policy). To use the
Tags
parameter, kms:TagResource (IAM policy). For examples and information about related permissions, see Allow a user to create CMKs in the AWS Key Management Service Developer Guide.Related operations:
See
AWSKMSCreateKeyRequest
See
AWSKMSCreateKeyResponse
Declaration
Objective-C
- (id)createKey:(nonnull AWSKMSCreateKeyRequest *)request;
Swift
func createKey(_ request: AWSKMSCreateKeyRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the CreateKey service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSKMSCreateKeyResponse
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorMalformedPolicyDocument
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorInvalidArn
,AWSKMSErrorUnsupportedOperation
,AWSKMSErrorKMSInternal
,AWSKMSErrorLimitExceeded
,AWSKMSErrorTag
,AWSKMSErrorCustomKeyStoreNotFound
,AWSKMSErrorCustomKeyStoreInvalidState
,AWSKMSErrorCloudHsmClusterInvalidConfiguration
. -
Creates a unique customer managed customer master key (CMK) in your AWS account and Region.
You can use the
CreateKey
operation to create symmetric or asymmetric CMKs.Symmetric CMKs contain a 256-bit symmetric key that never leaves AWS KMS unencrypted. To use the CMK, you must call AWS KMS. You can use a symmetric CMK to encrypt and decrypt small amounts of data, but they are typically used to generate data keys and data keys pairs. For details, see GenerateDataKey and GenerateDataKeyPair.
Asymmetric CMKs can contain an RSA key pair or an Elliptic Curve (ECC) key pair. The private key in an asymmetric CMK never leaves AWS KMS unencrypted. However, you can use the GetPublicKey operation to download the public key so it can be used outside of AWS KMS. CMKs with RSA key pairs can be used to encrypt or decrypt data or sign and verify messages (but not both). CMKs with ECC key pairs can be used only to sign and verify messages.
For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
To create different types of CMKs, use the following guidance:
- Asymmetric CMKs
To create an asymmetric CMK, use the
CustomerMasterKeySpec
parameter to specify the type of key material in the CMK. Then, use theKeyUsage
parameter to determine whether the CMK will be used to encrypt and decrypt or sign and verify. You can’t change these properties after the CMK is created.- Symmetric CMKs
When creating a symmetric CMK, you don’t need to specify the
CustomerMasterKeySpec
orKeyUsage
parameters. The default value forCustomerMasterKeySpec
,SYMMETRIC_DEFAULT
, and the default value forKeyUsage
,ENCRYPT_DECRYPT
, are the only valid values for symmetric CMKs.- Imported Key Material
To import your own key material, begin by creating a symmetric CMK with no key material. To do this, use the
Origin
parameter ofCreateKey
with a value ofEXTERNAL
. Next, use GetParametersForImport operation to get a public key and import token, and use the public key to encrypt your key material. Then, use ImportKeyMaterial with your import token to import the key material. For step-by-step instructions, see Importing Key Material in the AWS Key Management Service Developer Guide. You cannot import the key material into an asymmetric CMK.- Custom Key Stores
To create a symmetric CMK in a custom key store, use the
CustomKeyStoreId
parameter to specify the custom key store. You must also use theOrigin
parameter with a value ofAWS_CLOUDHSM
. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs in different Availability Zones in the AWS Region.You cannot create an asymmetric CMK in a custom key store. For information about custom key stores in AWS KMS see Using Custom Key Stores in the AWS Key Management Service Developer Guide.
Cross-account use: No. You cannot use this operation to create a CMK in a different AWS account.
Required permissions: kms:CreateKey (IAM policy). To use the
Tags
parameter, kms:TagResource (IAM policy). For examples and information about related permissions, see Allow a user to create CMKs in the AWS Key Management Service Developer Guide.Related operations:
See
AWSKMSCreateKeyRequest
See
AWSKMSCreateKeyResponse
Declaration
Objective-C
- (void)createKey:(nonnull AWSKMSCreateKeyRequest *)request completionHandler:(void (^_Nullable)(AWSKMSCreateKeyResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func createKey(_ request: AWSKMSCreateKeyRequest, completionHandler: ((AWSKMSCreateKeyResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the CreateKey service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorMalformedPolicyDocument
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorInvalidArn
,AWSKMSErrorUnsupportedOperation
,AWSKMSErrorKMSInternal
,AWSKMSErrorLimitExceeded
,AWSKMSErrorTag
,AWSKMSErrorCustomKeyStoreNotFound
,AWSKMSErrorCustomKeyStoreInvalidState
,AWSKMSErrorCloudHsmClusterInvalidConfiguration
. -
Decrypts ciphertext that was encrypted by a AWS KMS customer master key (CMK) using any of the following operations:
You can use this operation to decrypt ciphertext that was encrypted under a symmetric or asymmetric CMK. When the CMK is asymmetric, you must specify the CMK and the encryption algorithm that was used to encrypt the ciphertext. For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
The Decrypt operation also decrypts ciphertext that was encrypted outside of AWS KMS by the public key in an AWS KMS asymmetric CMK. However, it cannot decrypt ciphertext produced by other libraries, such as the AWS Encryption SDK or Amazon S3 client-side encryption. These libraries return a ciphertext format that is incompatible with AWS KMS.
If the ciphertext was encrypted under a symmetric CMK, the
KeyId
parameter is optional. AWS KMS can get this information from metadata that it adds to the symmetric ciphertext blob. This feature adds durability to your implementation by ensuring that authorized users can decrypt ciphertext decades after it was encrypted, even if they’ve lost track of the CMK ID. However, specifying the CMK is always recommended as a best practice. When you use theKeyId
parameter to specify a CMK, AWS KMS only uses the CMK you specify. If the ciphertext was encrypted under a different CMK, theDecrypt
operation fails. This practice ensures that you use the CMK that you intend.Whenever possible, use key policies to give users permission to call the
Decrypt
operation on a particular CMK, instead of using IAM policies. Otherwise, you might create an IAM user policy that gives the userDecrypt
permission on all CMKs. This user could decrypt ciphertext that was encrypted by CMKs in other accounts if the key policy for the cross-account CMK permits it. If you must use an IAM policy forDecrypt
permissions, limit the user to particular CMKs or particular trusted accounts. For details, see Best practices for IAM policies in the AWS Key Management Service Developer Guide.The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: Yes. You can decrypt a ciphertext using a CMK in a different AWS account.
Required permissions: kms:Decrypt (key policy)
Related operations:
See
AWSKMSDecryptRequest
See
AWSKMSDecryptResponse
Declaration
Objective-C
- (id)decrypt:(nonnull AWSKMSDecryptRequest *)request;
Swift
func decrypt(_ request: AWSKMSDecryptRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the Decrypt service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSKMSDecryptResponse
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorDisabled
,AWSKMSErrorInvalidCiphertext
,AWSKMSErrorKeyUnavailable
,AWSKMSErrorIncorrectKey
,AWSKMSErrorInvalidKeyUsage
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorInvalidGrantToken
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
. -
Decrypts ciphertext that was encrypted by a AWS KMS customer master key (CMK) using any of the following operations:
You can use this operation to decrypt ciphertext that was encrypted under a symmetric or asymmetric CMK. When the CMK is asymmetric, you must specify the CMK and the encryption algorithm that was used to encrypt the ciphertext. For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
The Decrypt operation also decrypts ciphertext that was encrypted outside of AWS KMS by the public key in an AWS KMS asymmetric CMK. However, it cannot decrypt ciphertext produced by other libraries, such as the AWS Encryption SDK or Amazon S3 client-side encryption. These libraries return a ciphertext format that is incompatible with AWS KMS.
If the ciphertext was encrypted under a symmetric CMK, the
KeyId
parameter is optional. AWS KMS can get this information from metadata that it adds to the symmetric ciphertext blob. This feature adds durability to your implementation by ensuring that authorized users can decrypt ciphertext decades after it was encrypted, even if they’ve lost track of the CMK ID. However, specifying the CMK is always recommended as a best practice. When you use theKeyId
parameter to specify a CMK, AWS KMS only uses the CMK you specify. If the ciphertext was encrypted under a different CMK, theDecrypt
operation fails. This practice ensures that you use the CMK that you intend.Whenever possible, use key policies to give users permission to call the
Decrypt
operation on a particular CMK, instead of using IAM policies. Otherwise, you might create an IAM user policy that gives the userDecrypt
permission on all CMKs. This user could decrypt ciphertext that was encrypted by CMKs in other accounts if the key policy for the cross-account CMK permits it. If you must use an IAM policy forDecrypt
permissions, limit the user to particular CMKs or particular trusted accounts. For details, see Best practices for IAM policies in the AWS Key Management Service Developer Guide.The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: Yes. You can decrypt a ciphertext using a CMK in a different AWS account.
Required permissions: kms:Decrypt (key policy)
Related operations:
See
AWSKMSDecryptRequest
See
AWSKMSDecryptResponse
Declaration
Objective-C
- (void)decrypt:(nonnull AWSKMSDecryptRequest *)request completionHandler:(void (^_Nullable)(AWSKMSDecryptResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func decrypt(_ request: AWSKMSDecryptRequest, completionHandler: ((AWSKMSDecryptResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the Decrypt service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorDisabled
,AWSKMSErrorInvalidCiphertext
,AWSKMSErrorKeyUnavailable
,AWSKMSErrorIncorrectKey
,AWSKMSErrorInvalidKeyUsage
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorInvalidGrantToken
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
. -
Deletes the specified alias.
Because an alias is not a property of a CMK, you can delete and change the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs, use the ListAliases operation.
Each CMK can have multiple aliases. To change the alias of a CMK, use DeleteAlias to delete the current alias and CreateAlias to create a new alias. To associate an existing alias with a different customer master key (CMK), call UpdateAlias.
Cross-account use: No. You cannot perform this operation on an alias in a different AWS account.
Required permissions
kms:DeleteAlias on the alias (IAM policy).
kms:DeleteAlias on the CMK (key policy).
For details, see Controlling access to aliases in the AWS Key Management Service Developer Guide.
Related operations:
See
AWSKMSDeleteAliasRequest
Declaration
Objective-C
- (id)deleteAlias:(nonnull AWSKMSDeleteAliasRequest *)request;
Swift
func deleteAlias(_ request: AWSKMSDeleteAliasRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteAlias service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorDependencyTimeout
,AWSKMSErrorNotFound
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
. -
Deletes the specified alias.
Because an alias is not a property of a CMK, you can delete and change the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs, use the ListAliases operation.
Each CMK can have multiple aliases. To change the alias of a CMK, use DeleteAlias to delete the current alias and CreateAlias to create a new alias. To associate an existing alias with a different customer master key (CMK), call UpdateAlias.
Cross-account use: No. You cannot perform this operation on an alias in a different AWS account.
Required permissions
kms:DeleteAlias on the alias (IAM policy).
kms:DeleteAlias on the CMK (key policy).
For details, see Controlling access to aliases in the AWS Key Management Service Developer Guide.
Related operations:
See
AWSKMSDeleteAliasRequest
Declaration
Objective-C
- (void)deleteAlias:(nonnull AWSKMSDeleteAliasRequest *)request completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func deleteAlias(_ request: AWSKMSDeleteAliasRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DeleteAlias service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorDependencyTimeout
,AWSKMSErrorNotFound
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
. -
Deletes a custom key store. This operation does not delete the AWS CloudHSM cluster that is associated with the custom key store, or affect any users or keys in the cluster.
The custom key store that you delete cannot contain any AWS KMS customer master keys (CMKs). Before deleting the key store, verify that you will never need to use any of the CMKs in the key store for any cryptographic operations. Then, use ScheduleKeyDeletion to delete the AWS KMS customer master keys (CMKs) from the key store. When the scheduled waiting period expires, the
ScheduleKeyDeletion
operation deletes the CMKs. Then it makes a best effort to delete the key material from the associated cluster. However, you might need to manually delete the orphaned key material from the cluster and its backups.After all CMKs are deleted from AWS KMS, use DisconnectCustomKeyStore to disconnect the key store from AWS KMS. Then, you can delete the custom key store.
Instead of deleting the custom key store, consider using DisconnectCustomKeyStore to disconnect it from AWS KMS. While the key store is disconnected, you cannot create or use the CMKs in the key store. But, you do not need to delete CMKs and you can reconnect a disconnected custom key store at any time.
If the operation succeeds, it returns a JSON object with no properties.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
Cross-account use: No. You cannot perform this operation on a custom key store in a different AWS account.
Required permissions: kms:DeleteCustomKeyStore (IAM policy)
Related operations:
See
AWSKMSDeleteCustomKeyStoreRequest
See
AWSKMSDeleteCustomKeyStoreResponse
Declaration
Objective-C
- (id)deleteCustomKeyStore:(nonnull AWSKMSDeleteCustomKeyStoreRequest *)request;
Swift
func deleteCustomKeyStore(_ request: AWSKMSDeleteCustomKeyStoreRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteCustomKeyStore service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSKMSDeleteCustomKeyStoreResponse
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorCustomKeyStoreHasCMKs
,AWSKMSErrorCustomKeyStoreInvalidState
,AWSKMSErrorCustomKeyStoreNotFound
,AWSKMSErrorKMSInternal
. -
Deletes a custom key store. This operation does not delete the AWS CloudHSM cluster that is associated with the custom key store, or affect any users or keys in the cluster.
The custom key store that you delete cannot contain any AWS KMS customer master keys (CMKs). Before deleting the key store, verify that you will never need to use any of the CMKs in the key store for any cryptographic operations. Then, use ScheduleKeyDeletion to delete the AWS KMS customer master keys (CMKs) from the key store. When the scheduled waiting period expires, the
ScheduleKeyDeletion
operation deletes the CMKs. Then it makes a best effort to delete the key material from the associated cluster. However, you might need to manually delete the orphaned key material from the cluster and its backups.After all CMKs are deleted from AWS KMS, use DisconnectCustomKeyStore to disconnect the key store from AWS KMS. Then, you can delete the custom key store.
Instead of deleting the custom key store, consider using DisconnectCustomKeyStore to disconnect it from AWS KMS. While the key store is disconnected, you cannot create or use the CMKs in the key store. But, you do not need to delete CMKs and you can reconnect a disconnected custom key store at any time.
If the operation succeeds, it returns a JSON object with no properties.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
Cross-account use: No. You cannot perform this operation on a custom key store in a different AWS account.
Required permissions: kms:DeleteCustomKeyStore (IAM policy)
Related operations:
See
AWSKMSDeleteCustomKeyStoreRequest
See
AWSKMSDeleteCustomKeyStoreResponse
Declaration
Objective-C
- (void)deleteCustomKeyStore: (nonnull AWSKMSDeleteCustomKeyStoreRequest *)request completionHandler: (void (^_Nullable)(AWSKMSDeleteCustomKeyStoreResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func deleteCustomKeyStore(_ request: AWSKMSDeleteCustomKeyStoreRequest, completionHandler: ((AWSKMSDeleteCustomKeyStoreResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DeleteCustomKeyStore service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorCustomKeyStoreHasCMKs
,AWSKMSErrorCustomKeyStoreInvalidState
,AWSKMSErrorCustomKeyStoreNotFound
,AWSKMSErrorKMSInternal
. -
Deletes key material that you previously imported. This operation makes the specified customer master key (CMK) unusable. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.
When the specified CMK is in the
PendingDeletion
state, this operation does not change the CMK’s state. Otherwise, it changes the CMK’s state toPendingImport
.After you delete key material, you can use ImportKeyMaterial to reimport the same key material into the CMK.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.
Required permissions: kms:DeleteImportedKeyMaterial (key policy)
Related operations:
See
AWSKMSDeleteImportedKeyMaterialRequest
Declaration
Objective-C
- (id)deleteImportedKeyMaterial: (nonnull AWSKMSDeleteImportedKeyMaterialRequest *)request;
Swift
func deleteImportedKeyMaterial(_ request: AWSKMSDeleteImportedKeyMaterialRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteImportedKeyMaterial service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorInvalidArn
,AWSKMSErrorUnsupportedOperation
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorNotFound
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
. -
Deletes key material that you previously imported. This operation makes the specified customer master key (CMK) unusable. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.
When the specified CMK is in the
PendingDeletion
state, this operation does not change the CMK’s state. Otherwise, it changes the CMK’s state toPendingImport
.After you delete key material, you can use ImportKeyMaterial to reimport the same key material into the CMK.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.
Required permissions: kms:DeleteImportedKeyMaterial (key policy)
Related operations:
See
AWSKMSDeleteImportedKeyMaterialRequest
Declaration
Objective-C
- (void)deleteImportedKeyMaterial: (nonnull AWSKMSDeleteImportedKeyMaterialRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func deleteImportedKeyMaterial(_ request: AWSKMSDeleteImportedKeyMaterialRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DeleteImportedKeyMaterial service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorInvalidArn
,AWSKMSErrorUnsupportedOperation
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorNotFound
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
. -
Gets information about custom key stores in the account and region.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
By default, this operation returns information about all custom key stores in the account and region. To get only information about a particular custom key store, use either the
CustomKeyStoreName
orCustomKeyStoreId
parameter (but not both).To determine whether the custom key store is connected to its AWS CloudHSM cluster, use the
ConnectionState
element in the response. If an attempt to connect the custom key store failed, theConnectionState
value isFAILED
and theConnectionErrorCode
element in the response indicates the cause of the failure. For help interpreting theConnectionErrorCode
, see CustomKeyStoresListEntry.Custom key stores have a
DISCONNECTED
connection state if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If your custom key store state isCONNECTED
but you are having trouble using it, make sure that its associated AWS CloudHSM cluster is active and contains the minimum number of HSMs required for the operation, if any.For help repairing your custom key store, see the Troubleshooting Custom Key Stores topic in the AWS Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a custom key store in a different AWS account.
Required permissions: kms:DescribeCustomKeyStores (IAM policy)
Related operations:
See
AWSKMSDescribeCustomKeyStoresRequest
See
AWSKMSDescribeCustomKeyStoresResponse
Declaration
Objective-C
- (id)describeCustomKeyStores: (nonnull AWSKMSDescribeCustomKeyStoresRequest *)request;
Swift
func describeCustomKeyStores(_ request: AWSKMSDescribeCustomKeyStoresRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DescribeCustomKeyStores service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSKMSDescribeCustomKeyStoresResponse
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorCustomKeyStoreNotFound
,AWSKMSErrorKMSInternal
. -
Gets information about custom key stores in the account and region.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
By default, this operation returns information about all custom key stores in the account and region. To get only information about a particular custom key store, use either the
CustomKeyStoreName
orCustomKeyStoreId
parameter (but not both).To determine whether the custom key store is connected to its AWS CloudHSM cluster, use the
ConnectionState
element in the response. If an attempt to connect the custom key store failed, theConnectionState
value isFAILED
and theConnectionErrorCode
element in the response indicates the cause of the failure. For help interpreting theConnectionErrorCode
, see CustomKeyStoresListEntry.Custom key stores have a
DISCONNECTED
connection state if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If your custom key store state isCONNECTED
but you are having trouble using it, make sure that its associated AWS CloudHSM cluster is active and contains the minimum number of HSMs required for the operation, if any.For help repairing your custom key store, see the Troubleshooting Custom Key Stores topic in the AWS Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a custom key store in a different AWS account.
Required permissions: kms:DescribeCustomKeyStores (IAM policy)
Related operations:
See
AWSKMSDescribeCustomKeyStoresRequest
See
AWSKMSDescribeCustomKeyStoresResponse
Declaration
Objective-C
- (void)describeCustomKeyStores: (nonnull AWSKMSDescribeCustomKeyStoresRequest *)request completionHandler: (void (^_Nullable)( AWSKMSDescribeCustomKeyStoresResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func describeCustomKeyStores(_ request: AWSKMSDescribeCustomKeyStoresRequest, completionHandler: ((AWSKMSDescribeCustomKeyStoresResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DescribeCustomKeyStores service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorCustomKeyStoreNotFound
,AWSKMSErrorKMSInternal
. -
Provides detailed information about a customer master key (CMK). You can run
DescribeKey
on a customer managed CMK or an AWS managed CMK.This detailed information includes the key ARN, creation date (and deletion date, if applicable), the key state, and the origin and expiration date (if any) of the key material. For CMKs in custom key stores, it includes information about the custom key store, such as the key store ID and the AWS CloudHSM cluster ID. It includes fields, like
KeySpec
, that help you distinguish symmetric from asymmetric CMKs. It also provides information that is particularly important to asymmetric CMKs, such as the key usage (encryption or signing) and the encryption algorithms or signing algorithms that the CMK supports.DescribeKey
does not return the following information:Aliases associated with the CMK. To get this information, use ListAliases.
Whether automatic key rotation is enabled on the CMK. To get this information, use GetKeyRotationStatus. Also, some key states prevent a CMK from being automatically rotated. For details, see How Automatic Key Rotation Works in AWS Key Management Service Developer Guide.
Tags on the CMK. To get this information, use ListResourceTags.
Key policies and grants on the CMK. To get this information, use GetKeyPolicy and ListGrants.
If you call the
DescribeKey
operation on a predefined AWS alias, that is, an AWS alias with no key ID, AWS KMS creates an AWS managed CMK. Then, it associates the alias with the new CMK, and returns theKeyId
andArn
of the new CMK in the response.Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the
KeyId
parameter.Required permissions: kms:DescribeKey (key policy)
Related operations:
See
AWSKMSDescribeKeyRequest
See
AWSKMSDescribeKeyResponse
Declaration
Objective-C
- (id)describeKey:(nonnull AWSKMSDescribeKeyRequest *)request;
Swift
func describeKey(_ request: AWSKMSDescribeKeyRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DescribeKey service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSKMSDescribeKeyResponse
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorInvalidArn
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorKMSInternal
. -
Provides detailed information about a customer master key (CMK). You can run
DescribeKey
on a customer managed CMK or an AWS managed CMK.This detailed information includes the key ARN, creation date (and deletion date, if applicable), the key state, and the origin and expiration date (if any) of the key material. For CMKs in custom key stores, it includes information about the custom key store, such as the key store ID and the AWS CloudHSM cluster ID. It includes fields, like
KeySpec
, that help you distinguish symmetric from asymmetric CMKs. It also provides information that is particularly important to asymmetric CMKs, such as the key usage (encryption or signing) and the encryption algorithms or signing algorithms that the CMK supports.DescribeKey
does not return the following information:Aliases associated with the CMK. To get this information, use ListAliases.
Whether automatic key rotation is enabled on the CMK. To get this information, use GetKeyRotationStatus. Also, some key states prevent a CMK from being automatically rotated. For details, see How Automatic Key Rotation Works in AWS Key Management Service Developer Guide.
Tags on the CMK. To get this information, use ListResourceTags.
Key policies and grants on the CMK. To get this information, use GetKeyPolicy and ListGrants.
If you call the
DescribeKey
operation on a predefined AWS alias, that is, an AWS alias with no key ID, AWS KMS creates an AWS managed CMK. Then, it associates the alias with the new CMK, and returns theKeyId
andArn
of the new CMK in the response.Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the
KeyId
parameter.Required permissions: kms:DescribeKey (key policy)
Related operations:
See
AWSKMSDescribeKeyRequest
See
AWSKMSDescribeKeyResponse
Declaration
Objective-C
- (void)describeKey:(nonnull AWSKMSDescribeKeyRequest *)request completionHandler:(void (^_Nullable)(AWSKMSDescribeKeyResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func describeKey(_ request: AWSKMSDescribeKeyRequest, completionHandler: ((AWSKMSDescribeKeyResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DescribeKey service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorInvalidArn
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorKMSInternal
. -
Sets the state of a customer master key (CMK) to disabled. This change temporarily prevents use of the CMK for cryptographic operations.
For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.
Required permissions: kms:DisableKey (key policy)
Related operations: EnableKey
See
AWSKMSDisableKeyRequest
Declaration
Objective-C
- (id)disableKey:(nonnull AWSKMSDisableKeyRequest *)request;
Swift
func disableKey(_ request: AWSKMSDisableKeyRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DisableKey service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorInvalidArn
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
. -
Sets the state of a customer master key (CMK) to disabled. This change temporarily prevents use of the CMK for cryptographic operations.
For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.
Required permissions: kms:DisableKey (key policy)
Related operations: EnableKey
See
AWSKMSDisableKeyRequest
Declaration
Objective-C
- (void)disableKey:(nonnull AWSKMSDisableKeyRequest *)request completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func disableKey(_ request: AWSKMSDisableKeyRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DisableKey service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorInvalidArn
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
. -
Disables automatic rotation of the key material for the specified symmetric customer master key (CMK).
You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.
Required permissions: kms:DisableKeyRotation (key policy)
Related operations:
See
AWSKMSDisableKeyRotationRequest
Declaration
Objective-C
- (id)disableKeyRotation:(nonnull AWSKMSDisableKeyRotationRequest *)request;
Swift
func disableKeyRotation(_ request: AWSKMSDisableKeyRotationRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DisableKeyRotation service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorDisabled
,AWSKMSErrorInvalidArn
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
,AWSKMSErrorUnsupportedOperation
. -
Disables automatic rotation of the key material for the specified symmetric customer master key (CMK).
You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.
Required permissions: kms:DisableKeyRotation (key policy)
Related operations:
See
AWSKMSDisableKeyRotationRequest
Declaration
Objective-C
- (void)disableKeyRotation:(nonnull AWSKMSDisableKeyRotationRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func disableKeyRotation(_ request: AWSKMSDisableKeyRotationRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DisableKeyRotation service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorDisabled
,AWSKMSErrorInvalidArn
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
,AWSKMSErrorUnsupportedOperation
. -
Disconnects the custom key store from its associated AWS CloudHSM cluster. While a custom key store is disconnected, you can manage the custom key store and its customer master keys (CMKs), but you cannot create or use CMKs in the custom key store. You can reconnect the custom key store at any time.
While a custom key store is disconnected, all attempts to create customer master keys (CMKs) in the custom key store or to use existing CMKs in cryptographic operations will fail. This action can prevent users from storing and accessing sensitive data.
To find the connection state of a custom key store, use the DescribeCustomKeyStores operation. To reconnect a custom key store, use the ConnectCustomKeyStore operation.
If the operation succeeds, it returns a JSON object with no properties.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
Cross-account use: No. You cannot perform this operation on a custom key store in a different AWS account.
Required permissions: kms:DisconnectCustomKeyStore (IAM policy)
Related operations:
See
AWSKMSDisconnectCustomKeyStoreRequest
See
AWSKMSDisconnectCustomKeyStoreResponse
Declaration
Objective-C
- (id)disconnectCustomKeyStore: (nonnull AWSKMSDisconnectCustomKeyStoreRequest *)request;
Swift
func disconnectCustomKeyStore(_ request: AWSKMSDisconnectCustomKeyStoreRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DisconnectCustomKeyStore service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSKMSDisconnectCustomKeyStoreResponse
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorCustomKeyStoreInvalidState
,AWSKMSErrorCustomKeyStoreNotFound
,AWSKMSErrorKMSInternal
. -
Disconnects the custom key store from its associated AWS CloudHSM cluster. While a custom key store is disconnected, you can manage the custom key store and its customer master keys (CMKs), but you cannot create or use CMKs in the custom key store. You can reconnect the custom key store at any time.
While a custom key store is disconnected, all attempts to create customer master keys (CMKs) in the custom key store or to use existing CMKs in cryptographic operations will fail. This action can prevent users from storing and accessing sensitive data.
To find the connection state of a custom key store, use the DescribeCustomKeyStores operation. To reconnect a custom key store, use the ConnectCustomKeyStore operation.
If the operation succeeds, it returns a JSON object with no properties.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
Cross-account use: No. You cannot perform this operation on a custom key store in a different AWS account.
Required permissions: kms:DisconnectCustomKeyStore (IAM policy)
Related operations:
See
AWSKMSDisconnectCustomKeyStoreRequest
See
AWSKMSDisconnectCustomKeyStoreResponse
Declaration
Objective-C
- (void)disconnectCustomKeyStore: (nonnull AWSKMSDisconnectCustomKeyStoreRequest *)request completionHandler: (void (^_Nullable)( AWSKMSDisconnectCustomKeyStoreResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func disconnectCustomKeyStore(_ request: AWSKMSDisconnectCustomKeyStoreRequest, completionHandler: ((AWSKMSDisconnectCustomKeyStoreResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DisconnectCustomKeyStore service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorCustomKeyStoreInvalidState
,AWSKMSErrorCustomKeyStoreNotFound
,AWSKMSErrorKMSInternal
. -
Sets the key state of a customer master key (CMK) to enabled. This allows you to use the CMK for cryptographic operations.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.
Required permissions: kms:EnableKey (key policy)
Related operations: DisableKey
See
AWSKMSEnableKeyRequest
Declaration
Objective-C
- (id)enableKey:(nonnull AWSKMSEnableKeyRequest *)request;
Swift
func enableKey(_ request: AWSKMSEnableKeyRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the EnableKey service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorInvalidArn
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorKMSInternal
,AWSKMSErrorLimitExceeded
,AWSKMSErrorKMSInvalidState
. -
Sets the key state of a customer master key (CMK) to enabled. This allows you to use the CMK for cryptographic operations.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.
Required permissions: kms:EnableKey (key policy)
Related operations: DisableKey
See
AWSKMSEnableKeyRequest
Declaration
Objective-C
- (void)enableKey:(nonnull AWSKMSEnableKeyRequest *)request completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func enableKey(_ request: AWSKMSEnableKeyRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the EnableKey service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorInvalidArn
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorKMSInternal
,AWSKMSErrorLimitExceeded
,AWSKMSErrorKMSInvalidState
. -
Enables automatic rotation of the key material for the specified symmetric customer master key (CMK).
You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.
Required permissions: kms:EnableKeyRotation (key policy)
Related operations:
See
AWSKMSEnableKeyRotationRequest
Declaration
Objective-C
- (id)enableKeyRotation:(nonnull AWSKMSEnableKeyRotationRequest *)request;
Swift
func enableKeyRotation(_ request: AWSKMSEnableKeyRotationRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the EnableKeyRotation service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorDisabled
,AWSKMSErrorInvalidArn
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
,AWSKMSErrorUnsupportedOperation
. -
Enables automatic rotation of the key material for the specified symmetric customer master key (CMK).
You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.
Required permissions: kms:EnableKeyRotation (key policy)
Related operations:
See
AWSKMSEnableKeyRotationRequest
Declaration
Objective-C
- (void)enableKeyRotation:(nonnull AWSKMSEnableKeyRotationRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func enableKeyRotation(_ request: AWSKMSEnableKeyRotationRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the EnableKeyRotation service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorDisabled
,AWSKMSErrorInvalidArn
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
,AWSKMSErrorUnsupportedOperation
. -
Encrypts plaintext into ciphertext by using a customer master key (CMK). The
Encrypt
operation has two primary use cases:You can encrypt small amounts of arbitrary data, such as a personal identifier or database password, or other sensitive information.
You can use the
Encrypt
operation to move encrypted data from one AWS Region to another. For example, in Region A, generate a data key and use the plaintext key to encrypt your data. Then, in Region A, use theEncrypt
operation to encrypt the plaintext data key under a CMK in Region B. Now, you can move the encrypted data and the encrypted data key to Region B. When necessary, you can decrypt the encrypted data key and the encrypted data entirely within in Region B.
You don’t need to use the
Encrypt
operation to encrypt a data key. The GenerateDataKey and GenerateDataKeyPair operations return a plaintext data key and an encrypted copy of that data key.When you encrypt data, you must specify a symmetric or asymmetric CMK to use in the encryption operation. The CMK must have a
KeyUsage
value ofENCRYPT_DECRYPT.
To find theKeyUsage
of a CMK, use the DescribeKey operation.If you use a symmetric CMK, you can use an encryption context to add additional security to your encryption operation. If you specify an
EncryptionContext
when encrypting data, you must specify the same encryption context (a case-sensitive exact match) when decrypting the data. Otherwise, the request to decrypt fails with anInvalidCiphertextException
. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.If you specify an asymmetric CMK, you must also specify the encryption algorithm. The algorithm must be compatible with the CMK type.
When you use an asymmetric CMK to encrypt or reencrypt data, be sure to record the CMK and encryption algorithm that you choose. You will be required to provide the same CMK and encryption algorithm when you decrypt the data. If the CMK and algorithm do not match the values used to encrypt the data, the decrypt operation fails.
You are not required to supply the CMK ID and encryption algorithm when you decrypt with symmetric CMKs because AWS KMS stores this information in the ciphertext blob. AWS KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields.
The maximum size of the data that you can encrypt varies with the type of CMK and the encryption algorithm that you choose.
Symmetric CMKs
SYMMETRIC_DEFAULT
: 4096 bytes
RSA_2048
RSAES_OAEP_SHA_1
: 214 bytesRSAES_OAEP_SHA_256
: 190 bytes
RSA_3072
RSAES_OAEP_SHA_1
: 342 bytesRSAES_OAEP_SHA_256
: 318 bytes
RSA_4096
RSAES_OAEP_SHA_1
: 470 bytesRSAES_OAEP_SHA_256
: 446 bytes
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the
KeyId
parameter.Required permissions: kms:Encrypt (key policy)
Related operations:
See
AWSKMSEncryptRequest
See
AWSKMSEncryptResponse
Declaration
Objective-C
- (id)encrypt:(nonnull AWSKMSEncryptRequest *)request;
Swift
func encrypt(_ request: AWSKMSEncryptRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the Encrypt service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSKMSEncryptResponse
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorDisabled
,AWSKMSErrorKeyUnavailable
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorInvalidKeyUsage
,AWSKMSErrorInvalidGrantToken
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
. -
Encrypts plaintext into ciphertext by using a customer master key (CMK). The
Encrypt
operation has two primary use cases:You can encrypt small amounts of arbitrary data, such as a personal identifier or database password, or other sensitive information.
You can use the
Encrypt
operation to move encrypted data from one AWS Region to another. For example, in Region A, generate a data key and use the plaintext key to encrypt your data. Then, in Region A, use theEncrypt
operation to encrypt the plaintext data key under a CMK in Region B. Now, you can move the encrypted data and the encrypted data key to Region B. When necessary, you can decrypt the encrypted data key and the encrypted data entirely within in Region B.
You don’t need to use the
Encrypt
operation to encrypt a data key. The GenerateDataKey and GenerateDataKeyPair operations return a plaintext data key and an encrypted copy of that data key.When you encrypt data, you must specify a symmetric or asymmetric CMK to use in the encryption operation. The CMK must have a
KeyUsage
value ofENCRYPT_DECRYPT.
To find theKeyUsage
of a CMK, use the DescribeKey operation.If you use a symmetric CMK, you can use an encryption context to add additional security to your encryption operation. If you specify an
EncryptionContext
when encrypting data, you must specify the same encryption context (a case-sensitive exact match) when decrypting the data. Otherwise, the request to decrypt fails with anInvalidCiphertextException
. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.If you specify an asymmetric CMK, you must also specify the encryption algorithm. The algorithm must be compatible with the CMK type.
When you use an asymmetric CMK to encrypt or reencrypt data, be sure to record the CMK and encryption algorithm that you choose. You will be required to provide the same CMK and encryption algorithm when you decrypt the data. If the CMK and algorithm do not match the values used to encrypt the data, the decrypt operation fails.
You are not required to supply the CMK ID and encryption algorithm when you decrypt with symmetric CMKs because AWS KMS stores this information in the ciphertext blob. AWS KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields.
The maximum size of the data that you can encrypt varies with the type of CMK and the encryption algorithm that you choose.
Symmetric CMKs
SYMMETRIC_DEFAULT
: 4096 bytes
RSA_2048
RSAES_OAEP_SHA_1
: 214 bytesRSAES_OAEP_SHA_256
: 190 bytes
RSA_3072
RSAES_OAEP_SHA_1
: 342 bytesRSAES_OAEP_SHA_256
: 318 bytes
RSA_4096
RSAES_OAEP_SHA_1
: 470 bytesRSAES_OAEP_SHA_256
: 446 bytes
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the
KeyId
parameter.Required permissions: kms:Encrypt (key policy)
Related operations:
See
AWSKMSEncryptRequest
See
AWSKMSEncryptResponse
Declaration
Objective-C
- (void)encrypt:(nonnull AWSKMSEncryptRequest *)request completionHandler:(void (^_Nullable)(AWSKMSEncryptResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func encrypt(_ request: AWSKMSEncryptRequest, completionHandler: ((AWSKMSEncryptResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the Encrypt service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorDisabled
,AWSKMSErrorKeyUnavailable
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorInvalidKeyUsage
,AWSKMSErrorInvalidGrantToken
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
. -
Generates a unique symmetric data key for client-side encryption. This operation returns a plaintext copy of the data key and a copy that is encrypted under a customer master key (CMK) that you specify. You can use the plaintext key to encrypt your data outside of AWS KMS and store the encrypted data key with the encrypted data.
GenerateDataKey
returns a unique data key for each request. The bytes in the plaintext key are not related to the caller or the CMK.To generate a data key, specify the symmetric CMK that will be used to encrypt the data key. You cannot use an asymmetric CMK to generate data keys. To get the type of your CMK, use the DescribeKey operation. You must also specify the length of the data key. Use either the
KeySpec
orNumberOfBytes
parameters (but not both). For 128-bit and 256-bit data keys, use theKeySpec
parameter.To get only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To generate an asymmetric data key pair, use the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operation. To get a cryptographically secure random byte string, use GenerateRandom.
You can use the optional encryption context to add additional security to the encryption operation. If you specify an
EncryptionContext
, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with anInvalidCiphertextException
. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
How to use your data key
We recommend that you use the following pattern to encrypt data locally in your application. You can write your own code or use a client-side encryption library, such as the AWS Encryption SDK, the Amazon DynamoDB Encryption Client, or Amazon S3 client-side encryption to do these tasks for you.
To encrypt data outside of AWS KMS:
Use the
GenerateDataKey
operation to get a data key.Use the plaintext data key (in the
Plaintext
field of the response) to encrypt your data outside of AWS KMS. Then erase the plaintext data key from memory.Store the encrypted data key (in the
CiphertextBlob
field of the response) with the encrypted data.
To decrypt data outside of AWS KMS:
Use the Decrypt operation to decrypt the encrypted data key. The operation returns a plaintext copy of the data key.
Use the plaintext data key to decrypt data outside of AWS KMS, then erase the plaintext data key from memory.
Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the
KeyId
parameter.Required permissions: kms:GenerateDataKey (key policy)
Related operations:
See
AWSKMSGenerateDataKeyRequest
See
AWSKMSGenerateDataKeyResponse
Declaration
Objective-C
- (id)generateDataKey:(nonnull AWSKMSGenerateDataKeyRequest *)request;
Swift
func generateDataKey(_ request: AWSKMSGenerateDataKeyRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GenerateDataKey service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSKMSGenerateDataKeyResponse
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorDisabled
,AWSKMSErrorKeyUnavailable
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorInvalidKeyUsage
,AWSKMSErrorInvalidGrantToken
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
. -
Generates a unique symmetric data key for client-side encryption. This operation returns a plaintext copy of the data key and a copy that is encrypted under a customer master key (CMK) that you specify. You can use the plaintext key to encrypt your data outside of AWS KMS and store the encrypted data key with the encrypted data.
GenerateDataKey
returns a unique data key for each request. The bytes in the plaintext key are not related to the caller or the CMK.To generate a data key, specify the symmetric CMK that will be used to encrypt the data key. You cannot use an asymmetric CMK to generate data keys. To get the type of your CMK, use the DescribeKey operation. You must also specify the length of the data key. Use either the
KeySpec
orNumberOfBytes
parameters (but not both). For 128-bit and 256-bit data keys, use theKeySpec
parameter.To get only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To generate an asymmetric data key pair, use the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operation. To get a cryptographically secure random byte string, use GenerateRandom.
You can use the optional encryption context to add additional security to the encryption operation. If you specify an
EncryptionContext
, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with anInvalidCiphertextException
. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
How to use your data key
We recommend that you use the following pattern to encrypt data locally in your application. You can write your own code or use a client-side encryption library, such as the AWS Encryption SDK, the Amazon DynamoDB Encryption Client, or Amazon S3 client-side encryption to do these tasks for you.
To encrypt data outside of AWS KMS:
Use the
GenerateDataKey
operation to get a data key.Use the plaintext data key (in the
Plaintext
field of the response) to encrypt your data outside of AWS KMS. Then erase the plaintext data key from memory.Store the encrypted data key (in the
CiphertextBlob
field of the response) with the encrypted data.
To decrypt data outside of AWS KMS:
Use the Decrypt operation to decrypt the encrypted data key. The operation returns a plaintext copy of the data key.
Use the plaintext data key to decrypt data outside of AWS KMS, then erase the plaintext data key from memory.
Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the
KeyId
parameter.Required permissions: kms:GenerateDataKey (key policy)
Related operations:
See
AWSKMSGenerateDataKeyRequest
See
AWSKMSGenerateDataKeyResponse
Declaration
Objective-C
- (void)generateDataKey:(nonnull AWSKMSGenerateDataKeyRequest *)request completionHandler: (void (^_Nullable)(AWSKMSGenerateDataKeyResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func generateDataKey(_ request: AWSKMSGenerateDataKeyRequest, completionHandler: ((AWSKMSGenerateDataKeyResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the GenerateDataKey service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorDisabled
,AWSKMSErrorKeyUnavailable
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorInvalidKeyUsage
,AWSKMSErrorInvalidGrantToken
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
. -
Generates a unique asymmetric data key pair. The
GenerateDataKeyPair
operation returns a plaintext public key, a plaintext private key, and a copy of the private key that is encrypted under the symmetric CMK you specify. You can use the data key pair to perform asymmetric cryptography outside of AWS KMS.GenerateDataKeyPair
returns a unique data key pair for each request. The bytes in the keys are not related to the caller or the CMK that is used to encrypt the private key.You can use the public key that
GenerateDataKeyPair
returns to encrypt data or verify a signature outside of AWS KMS. Then, store the encrypted private key with the data. When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.To generate a data key pair, you must specify a symmetric customer master key (CMK) to encrypt the private key in a data key pair. You cannot use an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your CMK, use the DescribeKey operation.
If you are using the data key pair to encrypt data, or for any operation where you don’t immediately need a private key, consider using the GenerateDataKeyPairWithoutPlaintext operation.
GenerateDataKeyPairWithoutPlaintext
returns a plaintext public key and an encrypted private key, but omits the plaintext private key that you need only to decrypt ciphertext or sign a message. Later, when you need to decrypt the data or sign a message, use the Decrypt operation to decrypt the encrypted private key in the data key pair.You can use the optional encryption context to add additional security to the encryption operation. If you specify an
EncryptionContext
, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with anInvalidCiphertextException
. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the
KeyId
parameter.Required permissions: kms:GenerateDataKeyPair (key policy)
Related operations:
See
AWSKMSGenerateDataKeyPairRequest
See
AWSKMSGenerateDataKeyPairResponse
Declaration
Objective-C
- (id)generateDataKeyPair:(nonnull AWSKMSGenerateDataKeyPairRequest *)request;
Swift
func generateDataKeyPair(_ request: AWSKMSGenerateDataKeyPairRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GenerateDataKeyPair service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSKMSGenerateDataKeyPairResponse
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorDisabled
,AWSKMSErrorKeyUnavailable
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorInvalidKeyUsage
,AWSKMSErrorInvalidGrantToken
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
,AWSKMSErrorUnsupportedOperation
. -
Generates a unique asymmetric data key pair. The
GenerateDataKeyPair
operation returns a plaintext public key, a plaintext private key, and a copy of the private key that is encrypted under the symmetric CMK you specify. You can use the data key pair to perform asymmetric cryptography outside of AWS KMS.GenerateDataKeyPair
returns a unique data key pair for each request. The bytes in the keys are not related to the caller or the CMK that is used to encrypt the private key.You can use the public key that
GenerateDataKeyPair
returns to encrypt data or verify a signature outside of AWS KMS. Then, store the encrypted private key with the data. When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.To generate a data key pair, you must specify a symmetric customer master key (CMK) to encrypt the private key in a data key pair. You cannot use an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your CMK, use the DescribeKey operation.
If you are using the data key pair to encrypt data, or for any operation where you don’t immediately need a private key, consider using the GenerateDataKeyPairWithoutPlaintext operation.
GenerateDataKeyPairWithoutPlaintext
returns a plaintext public key and an encrypted private key, but omits the plaintext private key that you need only to decrypt ciphertext or sign a message. Later, when you need to decrypt the data or sign a message, use the Decrypt operation to decrypt the encrypted private key in the data key pair.You can use the optional encryption context to add additional security to the encryption operation. If you specify an
EncryptionContext
, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with anInvalidCiphertextException
. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the
KeyId
parameter.Required permissions: kms:GenerateDataKeyPair (key policy)
Related operations:
See
AWSKMSGenerateDataKeyPairRequest
See
AWSKMSGenerateDataKeyPairResponse
Declaration
Objective-C
- (void)generateDataKeyPair:(nonnull AWSKMSGenerateDataKeyPairRequest *)request completionHandler: (void (^_Nullable)(AWSKMSGenerateDataKeyPairResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func generateDataKeyPair(_ request: AWSKMSGenerateDataKeyPairRequest, completionHandler: ((AWSKMSGenerateDataKeyPairResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the GenerateDataKeyPair service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorDisabled
,AWSKMSErrorKeyUnavailable
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorInvalidKeyUsage
,AWSKMSErrorInvalidGrantToken
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
,AWSKMSErrorUnsupportedOperation
. -
Generates a unique asymmetric data key pair. The
GenerateDataKeyPairWithoutPlaintext
operation returns a plaintext public key and a copy of the private key that is encrypted under the symmetric CMK you specify. Unlike GenerateDataKeyPair, this operation does not return a plaintext private key.To generate a data key pair, you must specify a symmetric customer master key (CMK) to encrypt the private key in the data key pair. You cannot use an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your CMK, use the
KeySpec
field in the DescribeKey response.You can use the public key that
GenerateDataKeyPairWithoutPlaintext
returns to encrypt data or verify a signature outside of AWS KMS. Then, store the encrypted private key with the data. When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.GenerateDataKeyPairWithoutPlaintext
returns a unique data key pair for each request. The bytes in the key are not related to the caller or CMK that is used to encrypt the private key.You can use the optional encryption context to add additional security to the encryption operation. If you specify an
EncryptionContext
, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with anInvalidCiphertextException
. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the
KeyId
parameter.Required permissions: kms:GenerateDataKeyPairWithoutPlaintext (key policy)
Related operations:
See
AWSKMSGenerateDataKeyPairWithoutPlaintextRequest
See
AWSKMSGenerateDataKeyPairWithoutPlaintextResponse
Declaration
Objective-C
- (id)generateDataKeyPairWithoutPlaintext: (nonnull AWSKMSGenerateDataKeyPairWithoutPlaintextRequest *)request;
Swift
func generateDataKeyPairWithoutPlaintext(_ request: AWSKMSGenerateDataKeyPairWithoutPlaintextRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GenerateDataKeyPairWithoutPlaintext service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSKMSGenerateDataKeyPairWithoutPlaintextResponse
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorDisabled
,AWSKMSErrorKeyUnavailable
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorInvalidKeyUsage
,AWSKMSErrorInvalidGrantToken
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
,AWSKMSErrorUnsupportedOperation
. -
Generates a unique asymmetric data key pair. The
GenerateDataKeyPairWithoutPlaintext
operation returns a plaintext public key and a copy of the private key that is encrypted under the symmetric CMK you specify. Unlike GenerateDataKeyPair, this operation does not return a plaintext private key.To generate a data key pair, you must specify a symmetric customer master key (CMK) to encrypt the private key in the data key pair. You cannot use an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your CMK, use the
KeySpec
field in the DescribeKey response.You can use the public key that
GenerateDataKeyPairWithoutPlaintext
returns to encrypt data or verify a signature outside of AWS KMS. Then, store the encrypted private key with the data. When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.GenerateDataKeyPairWithoutPlaintext
returns a unique data key pair for each request. The bytes in the key are not related to the caller or CMK that is used to encrypt the private key.You can use the optional encryption context to add additional security to the encryption operation. If you specify an
EncryptionContext
, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with anInvalidCiphertextException
. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the
KeyId
parameter.Required permissions: kms:GenerateDataKeyPairWithoutPlaintext (key policy)
Related operations:
See
AWSKMSGenerateDataKeyPairWithoutPlaintextRequest
See
AWSKMSGenerateDataKeyPairWithoutPlaintextResponse
Declaration
Objective-C
- (void) generateDataKeyPairWithoutPlaintext: (nonnull AWSKMSGenerateDataKeyPairWithoutPlaintextRequest *)request completionHandler: (void (^_Nullable)( AWSKMSGenerateDataKeyPairWithoutPlaintextResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func generateDataKeyPairWithoutPlaintext(_ request: AWSKMSGenerateDataKeyPairWithoutPlaintextRequest, completionHandler: ((AWSKMSGenerateDataKeyPairWithoutPlaintextResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the GenerateDataKeyPairWithoutPlaintext service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorDisabled
,AWSKMSErrorKeyUnavailable
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorInvalidKeyUsage
,AWSKMSErrorInvalidGrantToken
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
,AWSKMSErrorUnsupportedOperation
. -
Generates a unique symmetric data key. This operation returns a data key that is encrypted under a customer master key (CMK) that you specify. To request an asymmetric data key pair, use the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operations.
GenerateDataKeyWithoutPlaintext
is identical to the GenerateDataKey operation except that returns only the encrypted copy of the data key. This operation is useful for systems that need to encrypt data at some point, but not immediately. When you need to encrypt the data, you call the Decrypt operation on the encrypted copy of the key.It’s also useful in distributed systems with different levels of trust. For example, you might store encrypted data in containers. One component of your system creates new containers and stores an encrypted data key with each container. Then, a different component puts the data into the containers. That component first decrypts the data key, uses the plaintext data key to encrypt data, puts the encrypted data into the container, and then destroys the plaintext data key. In this system, the component that creates the containers never sees the plaintext data key.
GenerateDataKeyWithoutPlaintext
returns a unique data key for each request. The bytes in the keys are not related to the caller or CMK that is used to encrypt the private key.To generate a data key, you must specify the symmetric customer master key (CMK) that is used to encrypt the data key. You cannot use an asymmetric CMK to generate a data key. To get the type of your CMK, use the DescribeKey operation.
If the operation succeeds, you will find the encrypted copy of the data key in the
CiphertextBlob
field.You can use the optional encryption context to add additional security to the encryption operation. If you specify an
EncryptionContext
, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with anInvalidCiphertextException
. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the
KeyId
parameter.Required permissions: kms:GenerateDataKeyWithoutPlaintext (key policy)
Related operations:
See
AWSKMSGenerateDataKeyWithoutPlaintextRequest
See
AWSKMSGenerateDataKeyWithoutPlaintextResponse
Declaration
Objective-C
- (id)generateDataKeyWithoutPlaintext: (nonnull AWSKMSGenerateDataKeyWithoutPlaintextRequest *)request;
Swift
func generateDataKeyWithoutPlaintext(_ request: AWSKMSGenerateDataKeyWithoutPlaintextRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GenerateDataKeyWithoutPlaintext service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSKMSGenerateDataKeyWithoutPlaintextResponse
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorDisabled
,AWSKMSErrorKeyUnavailable
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorInvalidKeyUsage
,AWSKMSErrorInvalidGrantToken
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
. -
Generates a unique symmetric data key. This operation returns a data key that is encrypted under a customer master key (CMK) that you specify. To request an asymmetric data key pair, use the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operations.
GenerateDataKeyWithoutPlaintext
is identical to the GenerateDataKey operation except that returns only the encrypted copy of the data key. This operation is useful for systems that need to encrypt data at some point, but not immediately. When you need to encrypt the data, you call the Decrypt operation on the encrypted copy of the key.It’s also useful in distributed systems with different levels of trust. For example, you might store encrypted data in containers. One component of your system creates new containers and stores an encrypted data key with each container. Then, a different component puts the data into the containers. That component first decrypts the data key, uses the plaintext data key to encrypt data, puts the encrypted data into the container, and then destroys the plaintext data key. In this system, the component that creates the containers never sees the plaintext data key.
GenerateDataKeyWithoutPlaintext
returns a unique data key for each request. The bytes in the keys are not related to the caller or CMK that is used to encrypt the private key.To generate a data key, you must specify the symmetric customer master key (CMK) that is used to encrypt the data key. You cannot use an asymmetric CMK to generate a data key. To get the type of your CMK, use the DescribeKey operation.
If the operation succeeds, you will find the encrypted copy of the data key in the
CiphertextBlob
field.You can use the optional encryption context to add additional security to the encryption operation. If you specify an
EncryptionContext
, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with anInvalidCiphertextException
. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the
KeyId
parameter.Required permissions: kms:GenerateDataKeyWithoutPlaintext (key policy)
Related operations:
See
AWSKMSGenerateDataKeyWithoutPlaintextRequest
See
AWSKMSGenerateDataKeyWithoutPlaintextResponse
Declaration
Objective-C
- (void)generateDataKeyWithoutPlaintext: (nonnull AWSKMSGenerateDataKeyWithoutPlaintextRequest *)request completionHandler: (void (^_Nullable)( AWSKMSGenerateDataKeyWithoutPlaintextResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func generateDataKeyWithoutPlaintext(_ request: AWSKMSGenerateDataKeyWithoutPlaintextRequest, completionHandler: ((AWSKMSGenerateDataKeyWithoutPlaintextResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the GenerateDataKeyWithoutPlaintext service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorDisabled
,AWSKMSErrorKeyUnavailable
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorInvalidKeyUsage
,AWSKMSErrorInvalidGrantToken
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
. -
Returns a random byte string that is cryptographically secure.
By default, the random byte string is generated in AWS KMS. To generate the byte string in the AWS CloudHSM cluster that is associated with a custom key store, specify the custom key store ID.
For more information about entropy and random number generation, see the AWS Key Management Service Cryptographic Details whitepaper.
Required permissions: kms:GenerateRandom (IAM policy)
See
AWSKMSGenerateRandomRequest
See
AWSKMSGenerateRandomResponse
Declaration
Objective-C
- (id)generateRandom:(nonnull AWSKMSGenerateRandomRequest *)request;
Swift
func generateRandom(_ request: AWSKMSGenerateRandomRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GenerateRandom service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSKMSGenerateRandomResponse
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorDependencyTimeout
,AWSKMSErrorKMSInternal
,AWSKMSErrorCustomKeyStoreNotFound
,AWSKMSErrorCustomKeyStoreInvalidState
. -
Returns a random byte string that is cryptographically secure.
By default, the random byte string is generated in AWS KMS. To generate the byte string in the AWS CloudHSM cluster that is associated with a custom key store, specify the custom key store ID.
For more information about entropy and random number generation, see the AWS Key Management Service Cryptographic Details whitepaper.
Required permissions: kms:GenerateRandom (IAM policy)
See
AWSKMSGenerateRandomRequest
See
AWSKMSGenerateRandomResponse
Declaration
Objective-C
- (void)generateRandom:(nonnull AWSKMSGenerateRandomRequest *)request completionHandler: (void (^_Nullable)(AWSKMSGenerateRandomResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func generateRandom(_ request: AWSKMSGenerateRandomRequest, completionHandler: ((AWSKMSGenerateRandomResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the GenerateRandom service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorDependencyTimeout
,AWSKMSErrorKMSInternal
,AWSKMSErrorCustomKeyStoreNotFound
,AWSKMSErrorCustomKeyStoreInvalidState
. -
Gets a key policy attached to the specified customer master key (CMK).
Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.
Required permissions: kms:GetKeyPolicy (key policy)
Related operations: PutKeyPolicy
See
AWSKMSGetKeyPolicyRequest
See
AWSKMSGetKeyPolicyResponse
Declaration
Objective-C
- (id)getKeyPolicy:(nonnull AWSKMSGetKeyPolicyRequest *)request;
Swift
func getKeyPolicy(_ request: AWSKMSGetKeyPolicyRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetKeyPolicy service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSKMSGetKeyPolicyResponse
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorInvalidArn
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
. -
Gets a key policy attached to the specified customer master key (CMK).
Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.
Required permissions: kms:GetKeyPolicy (key policy)
Related operations: PutKeyPolicy
See
AWSKMSGetKeyPolicyRequest
See
AWSKMSGetKeyPolicyResponse
Declaration
Objective-C
- (void)getKeyPolicy:(nonnull AWSKMSGetKeyPolicyRequest *)request completionHandler:(void (^_Nullable)(AWSKMSGetKeyPolicyResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func getKeyPolicy(_ request: AWSKMSGetKeyPolicyRequest, completionHandler: ((AWSKMSGetKeyPolicyResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the GetKeyPolicy service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorInvalidArn
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
. -
Gets a Boolean value that indicates whether automatic rotation of the key material is enabled for the specified customer master key (CMK).
You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. The key rotation status for these CMKs is always
false
.The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Disabled: The key rotation status does not change when you disable a CMK. However, while the CMK is disabled, AWS KMS does not rotate the backing key.
Pending deletion: While a CMK is pending deletion, its key rotation status is
false
and AWS KMS does not rotate the backing key. If you cancel the deletion, the original key rotation status is restored.
Cross-account use: Yes. To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the
KeyId
parameter.Required permissions: kms:GetKeyRotationStatus (key policy)
Related operations:
See
AWSKMSGetKeyRotationStatusRequest
See
AWSKMSGetKeyRotationStatusResponse
Declaration
Objective-C
- (id)getKeyRotationStatus:(nonnull AWSKMSGetKeyRotationStatusRequest *)request;
Swift
func getKeyRotationStatus(_ request: AWSKMSGetKeyRotationStatusRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetKeyRotationStatus service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSKMSGetKeyRotationStatusResponse
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorInvalidArn
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
,AWSKMSErrorUnsupportedOperation
. -
Gets a Boolean value that indicates whether automatic rotation of the key material is enabled for the specified customer master key (CMK).
You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store. The key rotation status for these CMKs is always
false
.The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Disabled: The key rotation status does not change when you disable a CMK. However, while the CMK is disabled, AWS KMS does not rotate the backing key.
Pending deletion: While a CMK is pending deletion, its key rotation status is
false
and AWS KMS does not rotate the backing key. If you cancel the deletion, the original key rotation status is restored.
Cross-account use: Yes. To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the
KeyId
parameter.Required permissions: kms:GetKeyRotationStatus (key policy)
Related operations:
See
AWSKMSGetKeyRotationStatusRequest
See
AWSKMSGetKeyRotationStatusResponse
Declaration
Objective-C
- (void)getKeyRotationStatus: (nonnull AWSKMSGetKeyRotationStatusRequest *)request completionHandler: (void (^_Nullable)(AWSKMSGetKeyRotationStatusResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func getKeyRotationStatus(_ request: AWSKMSGetKeyRotationStatusRequest, completionHandler: ((AWSKMSGetKeyRotationStatusResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the GetKeyRotationStatus service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorInvalidArn
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
,AWSKMSErrorUnsupportedOperation
. -
Returns the items you need to import key material into a symmetric, customer managed customer master key (CMK). For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.
This operation returns a public key and an import token. Use the public key to encrypt the symmetric key material. Store the import token to send with a subsequent ImportKeyMaterial request.
You must specify the key ID of the symmetric CMK into which you will import key material. This CMK’s
Origin
must beEXTERNAL
. You must also specify the wrapping algorithm and type of wrapping key (public key) that you will use to encrypt the key material. You cannot perform this operation on an asymmetric CMK or on any CMK in a different AWS account.To import key material, you must use the public key and import token from the same response. These items are valid for 24 hours. The expiration date and time appear in the
GetParametersForImport
response. You cannot use an expired token in an ImportKeyMaterial request. If your key and token expire, send anotherGetParametersForImport
request.The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.
Required permissions: kms:GetParametersForImport (key policy)
Related operations:
See
AWSKMSGetParametersForImportRequest
See
AWSKMSGetParametersForImportResponse
Declaration
Objective-C
- (id)getParametersForImport: (nonnull AWSKMSGetParametersForImportRequest *)request;
Swift
func getParametersForImport(_ request: AWSKMSGetParametersForImportRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetParametersForImport service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSKMSGetParametersForImportResponse
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorInvalidArn
,AWSKMSErrorUnsupportedOperation
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorNotFound
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
. -
Returns the items you need to import key material into a symmetric, customer managed customer master key (CMK). For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.
This operation returns a public key and an import token. Use the public key to encrypt the symmetric key material. Store the import token to send with a subsequent ImportKeyMaterial request.
You must specify the key ID of the symmetric CMK into which you will import key material. This CMK’s
Origin
must beEXTERNAL
. You must also specify the wrapping algorithm and type of wrapping key (public key) that you will use to encrypt the key material. You cannot perform this operation on an asymmetric CMK or on any CMK in a different AWS account.To import key material, you must use the public key and import token from the same response. These items are valid for 24 hours. The expiration date and time appear in the
GetParametersForImport
response. You cannot use an expired token in an ImportKeyMaterial request. If your key and token expire, send anotherGetParametersForImport
request.The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.
Required permissions: kms:GetParametersForImport (key policy)
Related operations:
See
AWSKMSGetParametersForImportRequest
See
AWSKMSGetParametersForImportResponse
Declaration
Objective-C
- (void) getParametersForImport: (nonnull AWSKMSGetParametersForImportRequest *)request completionHandler: (void (^_Nullable)(AWSKMSGetParametersForImportResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func getParametersForImport(_ request: AWSKMSGetParametersForImportRequest, completionHandler: ((AWSKMSGetParametersForImportResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the GetParametersForImport service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorInvalidArn
,AWSKMSErrorUnsupportedOperation
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorNotFound
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
. -
Returns the public key of an asymmetric CMK. Unlike the private key of a asymmetric CMK, which never leaves AWS KMS unencrypted, callers with
kms:GetPublicKey
permission can download the public key of an asymmetric CMK. You can share the public key to allow others to encrypt messages and verify signatures outside of AWS KMS. For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.You do not need to download the public key. Instead, you can use the public key within AWS KMS by calling the Encrypt, ReEncrypt, or Verify operations with the identifier of an asymmetric CMK. When you use the public key within AWS KMS, you benefit from the authentication, authorization, and logging that are part of every AWS KMS operation. You also reduce of risk of encrypting data that cannot be decrypted. These features are not effective outside of AWS KMS. For details, see Special Considerations for Downloading Public Keys.
To help you use the public key safely outside of AWS KMS,
GetPublicKey
returns important information about the public key in the response, including:CustomerMasterKeySpec: The type of key material in the public key, such as
RSA_4096
orECC_NIST_P521
.KeyUsage: Whether the key is used for encryption or signing.
EncryptionAlgorithms or SigningAlgorithms: A list of the encryption algorithms or the signing algorithms for the key.
Although AWS KMS cannot enforce these restrictions on external operations, it is crucial that you use this information to prevent the public key from being used improperly. For example, you can prevent a public signing key from being used encrypt data, or prevent a public key from being used with an encryption algorithm that is not supported by AWS KMS. You can also avoid errors, such as using the wrong signing algorithm in a verification operation.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the
KeyId
parameter.Required permissions: kms:GetPublicKey (key policy)
Related operations: CreateKey
See
AWSKMSGetPublicKeyRequest
See
AWSKMSGetPublicKeyResponse
Declaration
Objective-C
- (id)getPublicKey:(nonnull AWSKMSGetPublicKeyRequest *)request;
Swift
func getPublicKey(_ request: AWSKMSGetPublicKeyRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the GetPublicKey service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSKMSGetPublicKeyResponse
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorDisabled
,AWSKMSErrorKeyUnavailable
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorUnsupportedOperation
,AWSKMSErrorInvalidArn
,AWSKMSErrorInvalidGrantToken
,AWSKMSErrorInvalidKeyUsage
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
. -
Returns the public key of an asymmetric CMK. Unlike the private key of a asymmetric CMK, which never leaves AWS KMS unencrypted, callers with
kms:GetPublicKey
permission can download the public key of an asymmetric CMK. You can share the public key to allow others to encrypt messages and verify signatures outside of AWS KMS. For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.You do not need to download the public key. Instead, you can use the public key within AWS KMS by calling the Encrypt, ReEncrypt, or Verify operations with the identifier of an asymmetric CMK. When you use the public key within AWS KMS, you benefit from the authentication, authorization, and logging that are part of every AWS KMS operation. You also reduce of risk of encrypting data that cannot be decrypted. These features are not effective outside of AWS KMS. For details, see Special Considerations for Downloading Public Keys.
To help you use the public key safely outside of AWS KMS,
GetPublicKey
returns important information about the public key in the response, including:CustomerMasterKeySpec: The type of key material in the public key, such as
RSA_4096
orECC_NIST_P521
.KeyUsage: Whether the key is used for encryption or signing.
EncryptionAlgorithms or SigningAlgorithms: A list of the encryption algorithms or the signing algorithms for the key.
Although AWS KMS cannot enforce these restrictions on external operations, it is crucial that you use this information to prevent the public key from being used improperly. For example, you can prevent a public signing key from being used encrypt data, or prevent a public key from being used with an encryption algorithm that is not supported by AWS KMS. You can also avoid errors, such as using the wrong signing algorithm in a verification operation.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the
KeyId
parameter.Required permissions: kms:GetPublicKey (key policy)
Related operations: CreateKey
See
AWSKMSGetPublicKeyRequest
See
AWSKMSGetPublicKeyResponse
Declaration
Objective-C
- (void)getPublicKey:(nonnull AWSKMSGetPublicKeyRequest *)request completionHandler:(void (^_Nullable)(AWSKMSGetPublicKeyResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func getPublicKey(_ request: AWSKMSGetPublicKeyRequest, completionHandler: ((AWSKMSGetPublicKeyResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the GetPublicKey service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorDisabled
,AWSKMSErrorKeyUnavailable
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorUnsupportedOperation
,AWSKMSErrorInvalidArn
,AWSKMSErrorInvalidGrantToken
,AWSKMSErrorInvalidKeyUsage
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
. -
Imports key material into an existing symmetric AWS KMS customer master key (CMK) that was created without key material. After you successfully import key material into a CMK, you can reimport the same key material into that CMK, but you cannot import different key material.
You cannot perform this operation on an asymmetric CMK or on any CMK in a different AWS account. For more information about creating CMKs with no key material and then importing key material, see Importing Key Material in the AWS Key Management Service Developer Guide.
Before using this operation, call GetParametersForImport. Its response includes a public key and an import token. Use the public key to encrypt the key material. Then, submit the import token from the same
GetParametersForImport
response.When calling this operation, you must specify the following values:
The key ID or key ARN of a CMK with no key material. Its
Origin
must beEXTERNAL
.To create a CMK with no key material, call CreateKey and set the value of its
Origin
parameter toEXTERNAL
. To get theOrigin
of a CMK, call DescribeKey.)The encrypted key material. To get the public key to encrypt the key material, call GetParametersForImport.
The import token that GetParametersForImport returned. You must use a public key and token from the same
GetParametersForImport
response.Whether the key material expires and if so, when. If you set an expiration date, AWS KMS deletes the key material from the CMK on the specified date, and the CMK becomes unusable. To use the CMK again, you must reimport the same key material. The only way to change an expiration date is by reimporting the same key material and specifying a new expiration date.
When this operation is successful, the key state of the CMK changes from
PendingImport
toEnabled
, and you can use the CMK.If this operation fails, use the exception to help determine the problem. If the error is related to the key material, the import token, or wrapping key, use GetParametersForImport to get a new public key and import token for the CMK and repeat the import procedure. For help, see How To Import Key Material in the AWS Key Management Service Developer Guide.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.
Required permissions: kms:ImportKeyMaterial (key policy)
Related operations:
See
AWSKMSImportKeyMaterialRequest
See
AWSKMSImportKeyMaterialResponse
Declaration
Objective-C
- (id)importKeyMaterial:(nonnull AWSKMSImportKeyMaterialRequest *)request;
Swift
func importKeyMaterial(_ request: AWSKMSImportKeyMaterialRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the ImportKeyMaterial service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSKMSImportKeyMaterialResponse
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorInvalidArn
,AWSKMSErrorUnsupportedOperation
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorNotFound
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
,AWSKMSErrorInvalidCiphertext
,AWSKMSErrorIncorrectKeyMaterial
,AWSKMSErrorExpiredImportToken
,AWSKMSErrorInvalidImportToken
. -
Imports key material into an existing symmetric AWS KMS customer master key (CMK) that was created without key material. After you successfully import key material into a CMK, you can reimport the same key material into that CMK, but you cannot import different key material.
You cannot perform this operation on an asymmetric CMK or on any CMK in a different AWS account. For more information about creating CMKs with no key material and then importing key material, see Importing Key Material in the AWS Key Management Service Developer Guide.
Before using this operation, call GetParametersForImport. Its response includes a public key and an import token. Use the public key to encrypt the key material. Then, submit the import token from the same
GetParametersForImport
response.When calling this operation, you must specify the following values:
The key ID or key ARN of a CMK with no key material. Its
Origin
must beEXTERNAL
.To create a CMK with no key material, call CreateKey and set the value of its
Origin
parameter toEXTERNAL
. To get theOrigin
of a CMK, call DescribeKey.)The encrypted key material. To get the public key to encrypt the key material, call GetParametersForImport.
The import token that GetParametersForImport returned. You must use a public key and token from the same
GetParametersForImport
response.Whether the key material expires and if so, when. If you set an expiration date, AWS KMS deletes the key material from the CMK on the specified date, and the CMK becomes unusable. To use the CMK again, you must reimport the same key material. The only way to change an expiration date is by reimporting the same key material and specifying a new expiration date.
When this operation is successful, the key state of the CMK changes from
PendingImport
toEnabled
, and you can use the CMK.If this operation fails, use the exception to help determine the problem. If the error is related to the key material, the import token, or wrapping key, use GetParametersForImport to get a new public key and import token for the CMK and repeat the import procedure. For help, see How To Import Key Material in the AWS Key Management Service Developer Guide.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.
Required permissions: kms:ImportKeyMaterial (key policy)
Related operations:
See
AWSKMSImportKeyMaterialRequest
See
AWSKMSImportKeyMaterialResponse
Declaration
Objective-C
- (void)importKeyMaterial:(nonnull AWSKMSImportKeyMaterialRequest *)request completionHandler: (void (^_Nullable)(AWSKMSImportKeyMaterialResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func importKeyMaterial(_ request: AWSKMSImportKeyMaterialRequest, completionHandler: ((AWSKMSImportKeyMaterialResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the ImportKeyMaterial service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorInvalidArn
,AWSKMSErrorUnsupportedOperation
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorNotFound
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
,AWSKMSErrorInvalidCiphertext
,AWSKMSErrorIncorrectKeyMaterial
,AWSKMSErrorExpiredImportToken
,AWSKMSErrorInvalidImportToken
. -
Gets a list of aliases in the caller’s AWS account and region. For more information about aliases, see CreateAlias.
By default, the
ListAliases
operation returns all aliases in the account and region. To get only the aliases associated with a particular customer master key (CMK), use theKeyId
parameter.The
ListAliases
response can include aliases that you created and associated with your customer managed CMKs, and aliases that AWS created and associated with AWS managed CMKs in your account. You can recognize AWS aliases because their names have the formataws/<service-name>
, such asaws/dynamodb
.The response might also include aliases that have no
TargetKeyId
field. These are predefined aliases that AWS has created but has not yet associated with a CMK. Aliases that AWS creates in your account, including predefined aliases, do not count against your AWS KMS aliases quota.Cross-account use: No.
ListAliases
does not return aliases in other AWS accounts.Required permissions: kms:ListAliases (IAM policy)
For details, see Controlling access to aliases in the AWS Key Management Service Developer Guide.
Related operations:
See
AWSKMSListAliasesRequest
See
AWSKMSListAliasesResponse
Declaration
Objective-C
- (id)listAliases:(nonnull AWSKMSListAliasesRequest *)request;
Swift
func listAliases(_ request: AWSKMSListAliasesRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the ListAliases service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSKMSListAliasesResponse
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorDependencyTimeout
,AWSKMSErrorInvalidMarker
,AWSKMSErrorKMSInternal
,AWSKMSErrorInvalidArn
,AWSKMSErrorNotFound
. -
Gets a list of aliases in the caller’s AWS account and region. For more information about aliases, see CreateAlias.
By default, the
ListAliases
operation returns all aliases in the account and region. To get only the aliases associated with a particular customer master key (CMK), use theKeyId
parameter.The
ListAliases
response can include aliases that you created and associated with your customer managed CMKs, and aliases that AWS created and associated with AWS managed CMKs in your account. You can recognize AWS aliases because their names have the formataws/<service-name>
, such asaws/dynamodb
.The response might also include aliases that have no
TargetKeyId
field. These are predefined aliases that AWS has created but has not yet associated with a CMK. Aliases that AWS creates in your account, including predefined aliases, do not count against your AWS KMS aliases quota.Cross-account use: No.
ListAliases
does not return aliases in other AWS accounts.Required permissions: kms:ListAliases (IAM policy)
For details, see Controlling access to aliases in the AWS Key Management Service Developer Guide.
Related operations:
See
AWSKMSListAliasesRequest
See
AWSKMSListAliasesResponse
Declaration
Objective-C
- (void)listAliases:(nonnull AWSKMSListAliasesRequest *)request completionHandler:(void (^_Nullable)(AWSKMSListAliasesResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func listAliases(_ request: AWSKMSListAliasesRequest, completionHandler: ((AWSKMSListAliasesResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the ListAliases service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorDependencyTimeout
,AWSKMSErrorInvalidMarker
,AWSKMSErrorKMSInternal
,AWSKMSErrorInvalidArn
,AWSKMSErrorNotFound
. -
Gets a list of all grants for the specified customer master key (CMK).
The
GranteePrincipal
field in theListGrants
response usually contains the user or role designated as the grantee principal in the grant. However, when the grantee principal in the grant is an AWS service, theGranteePrincipal
field contains the service principal, which might represent several different grantee principals.Cross-account use: Yes. To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the
KeyId
parameter.Required permissions: kms:ListGrants (key policy)
Related operations:
See
AWSKMSListGrantsRequest
See
AWSKMSListGrantsResponse
Declaration
Objective-C
- (id)listGrants:(nonnull AWSKMSListGrantsRequest *)request;
Swift
func listGrants(_ request: AWSKMSListGrantsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the ListGrants service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSKMSListGrantsResponse
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorInvalidMarker
,AWSKMSErrorInvalidArn
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
. -
Gets a list of all grants for the specified customer master key (CMK).
The
GranteePrincipal
field in theListGrants
response usually contains the user or role designated as the grantee principal in the grant. However, when the grantee principal in the grant is an AWS service, theGranteePrincipal
field contains the service principal, which might represent several different grantee principals.Cross-account use: Yes. To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the
KeyId
parameter.Required permissions: kms:ListGrants (key policy)
Related operations:
See
AWSKMSListGrantsRequest
See
AWSKMSListGrantsResponse
Declaration
Objective-C
- (void)listGrants:(nonnull AWSKMSListGrantsRequest *)request completionHandler:(void (^_Nullable)(AWSKMSListGrantsResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func listGrants(_ request: AWSKMSListGrantsRequest, completionHandler: ((AWSKMSListGrantsResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the ListGrants service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorInvalidMarker
,AWSKMSErrorInvalidArn
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
. -
Gets the names of the key policies that are attached to a customer master key (CMK). This operation is designed to get policy names that you can use in a GetKeyPolicy operation. However, the only valid policy name is
default
.Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.
Required permissions: kms:ListKeyPolicies (key policy)
Related operations:
See
AWSKMSListKeyPoliciesRequest
See
AWSKMSListKeyPoliciesResponse
Declaration
Objective-C
- (id)listKeyPolicies:(nonnull AWSKMSListKeyPoliciesRequest *)request;
Swift
func listKeyPolicies(_ request: AWSKMSListKeyPoliciesRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the ListKeyPolicies service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSKMSListKeyPoliciesResponse
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorInvalidArn
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
. -
Gets the names of the key policies that are attached to a customer master key (CMK). This operation is designed to get policy names that you can use in a GetKeyPolicy operation. However, the only valid policy name is
default
.Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.
Required permissions: kms:ListKeyPolicies (key policy)
Related operations:
See
AWSKMSListKeyPoliciesRequest
See
AWSKMSListKeyPoliciesResponse
Declaration
Objective-C
- (void)listKeyPolicies:(nonnull AWSKMSListKeyPoliciesRequest *)request completionHandler: (void (^_Nullable)(AWSKMSListKeyPoliciesResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func listKeyPolicies(_ request: AWSKMSListKeyPoliciesRequest, completionHandler: ((AWSKMSListKeyPoliciesResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the ListKeyPolicies service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorInvalidArn
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
. -
Gets a list of all customer master keys (CMKs) in the caller’s AWS account and Region.
Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.
Required permissions: kms:ListKeys (IAM policy)
Related operations:
See
AWSKMSListKeysRequest
See
AWSKMSListKeysResponse
Declaration
Objective-C
- (id)listKeys:(nonnull AWSKMSListKeysRequest *)request;
Swift
func listKeys(_ request: AWSKMSListKeysRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the ListKeys service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSKMSListKeysResponse
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorDependencyTimeout
,AWSKMSErrorKMSInternal
,AWSKMSErrorInvalidMarker
. -
Gets a list of all customer master keys (CMKs) in the caller’s AWS account and Region.
Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.
Required permissions: kms:ListKeys (IAM policy)
Related operations:
See
AWSKMSListKeysRequest
See
AWSKMSListKeysResponse
Declaration
Objective-C
- (void)listKeys:(nonnull AWSKMSListKeysRequest *)request completionHandler:(void (^_Nullable)(AWSKMSListKeysResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func listKeys(_ request: AWSKMSListKeysRequest, completionHandler: ((AWSKMSListKeysResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the ListKeys service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorDependencyTimeout
,AWSKMSErrorKMSInternal
,AWSKMSErrorInvalidMarker
. -
Returns all tags on the specified customer master key (CMK).
For general information about tags, including the format and syntax, see Tagging AWS resources in the Amazon Web Services General Reference. For information about using tags in AWS KMS, see Tagging keys.
Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.
Required permissions: kms:ListResourceTags (key policy)
Related operations:
See
AWSKMSListResourceTagsRequest
See
AWSKMSListResourceTagsResponse
Declaration
Objective-C
- (id)listResourceTags:(nonnull AWSKMSListResourceTagsRequest *)request;
Swift
func listResourceTags(_ request: AWSKMSListResourceTagsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the ListResourceTags service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSKMSListResourceTagsResponse
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorKMSInternal
,AWSKMSErrorNotFound
,AWSKMSErrorInvalidArn
,AWSKMSErrorInvalidMarker
. -
Returns all tags on the specified customer master key (CMK).
For general information about tags, including the format and syntax, see Tagging AWS resources in the Amazon Web Services General Reference. For information about using tags in AWS KMS, see Tagging keys.
Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.
Required permissions: kms:ListResourceTags (key policy)
Related operations:
See
AWSKMSListResourceTagsRequest
See
AWSKMSListResourceTagsResponse
Declaration
Objective-C
- (void)listResourceTags:(nonnull AWSKMSListResourceTagsRequest *)request completionHandler: (void (^_Nullable)(AWSKMSListResourceTagsResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func listResourceTags(_ request: AWSKMSListResourceTagsRequest, completionHandler: ((AWSKMSListResourceTagsResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the ListResourceTags service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorKMSInternal
,AWSKMSErrorNotFound
,AWSKMSErrorInvalidArn
,AWSKMSErrorInvalidMarker
. -
Returns all grants in which the specified principal is the
RetiringPrincipal
in the grant.You can specify any principal in your AWS account. The grants that are returned include grants for CMKs in your AWS account and other AWS accounts.
You might use this operation to determine which grants you may retire. To retire a grant, use the RetireGrant operation.
Cross-account use: You must specify a principal in your AWS account. However, this operation can return grants in any AWS account. You do not need
kms:ListRetirableGrants
permission (or any other additional permission) in any AWS account other than your own.Required permissions: kms:ListRetirableGrants (IAM policy) in your AWS account.
Related operations:
See
AWSKMSListRetirableGrantsRequest
See
AWSKMSListGrantsResponse
Declaration
Objective-C
- (id)listRetirableGrants:(nonnull AWSKMSListRetirableGrantsRequest *)request;
Swift
func listRetirableGrants(_ request: AWSKMSListRetirableGrantsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the ListRetirableGrants service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSKMSListGrantsResponse
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorDependencyTimeout
,AWSKMSErrorInvalidMarker
,AWSKMSErrorInvalidArn
,AWSKMSErrorNotFound
,AWSKMSErrorKMSInternal
. -
Returns all grants in which the specified principal is the
RetiringPrincipal
in the grant.You can specify any principal in your AWS account. The grants that are returned include grants for CMKs in your AWS account and other AWS accounts.
You might use this operation to determine which grants you may retire. To retire a grant, use the RetireGrant operation.
Cross-account use: You must specify a principal in your AWS account. However, this operation can return grants in any AWS account. You do not need
kms:ListRetirableGrants
permission (or any other additional permission) in any AWS account other than your own.Required permissions: kms:ListRetirableGrants (IAM policy) in your AWS account.
Related operations:
See
AWSKMSListRetirableGrantsRequest
See
AWSKMSListGrantsResponse
Declaration
Objective-C
- (void)listRetirableGrants:(nonnull AWSKMSListRetirableGrantsRequest *)request completionHandler: (void (^_Nullable)(AWSKMSListGrantsResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func listRetirableGrants(_ request: AWSKMSListRetirableGrantsRequest, completionHandler: ((AWSKMSListGrantsResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the ListRetirableGrants service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorDependencyTimeout
,AWSKMSErrorInvalidMarker
,AWSKMSErrorInvalidArn
,AWSKMSErrorNotFound
,AWSKMSErrorKMSInternal
. -
Attaches a key policy to the specified customer master key (CMK).
For more information about key policies, see Key Policies in the AWS Key Management Service Developer Guide. For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the IAM User Guide. For examples of adding a key policy in multiple programming languages, see Setting a key policy in the AWS Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.
Required permissions: kms:PutKeyPolicy (key policy)
Related operations: GetKeyPolicy
See
AWSKMSPutKeyPolicyRequest
Declaration
Objective-C
- (id)putKeyPolicy:(nonnull AWSKMSPutKeyPolicyRequest *)request;
Swift
func putKeyPolicy(_ request: AWSKMSPutKeyPolicyRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the PutKeyPolicy service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorInvalidArn
,AWSKMSErrorMalformedPolicyDocument
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorUnsupportedOperation
,AWSKMSErrorKMSInternal
,AWSKMSErrorLimitExceeded
,AWSKMSErrorKMSInvalidState
. -
Attaches a key policy to the specified customer master key (CMK).
For more information about key policies, see Key Policies in the AWS Key Management Service Developer Guide. For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the IAM User Guide. For examples of adding a key policy in multiple programming languages, see Setting a key policy in the AWS Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.
Required permissions: kms:PutKeyPolicy (key policy)
Related operations: GetKeyPolicy
See
AWSKMSPutKeyPolicyRequest
Declaration
Objective-C
- (void)putKeyPolicy:(nonnull AWSKMSPutKeyPolicyRequest *)request completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func putKeyPolicy(_ request: AWSKMSPutKeyPolicyRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the PutKeyPolicy service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorInvalidArn
,AWSKMSErrorMalformedPolicyDocument
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorUnsupportedOperation
,AWSKMSErrorKMSInternal
,AWSKMSErrorLimitExceeded
,AWSKMSErrorKMSInvalidState
. -
Decrypts ciphertext and then reencrypts it entirely within AWS KMS. You can use this operation to change the customer master key (CMK) under which data is encrypted, such as when you manually rotate a CMK or change the CMK that protects a ciphertext. You can also use it to reencrypt ciphertext under the same CMK, such as to change the encryption context of a ciphertext.
The
ReEncrypt
operation can decrypt ciphertext that was encrypted by using an AWS KMS CMK in an AWS KMS operation, such as Encrypt or GenerateDataKey. It can also decrypt ciphertext that was encrypted by using the public key of an asymmetric CMK outside of AWS KMS. However, it cannot decrypt ciphertext produced by other libraries, such as the AWS Encryption SDK or Amazon S3 client-side encryption. These libraries return a ciphertext format that is incompatible with AWS KMS.When you use the
ReEncrypt
operation, you need to provide information for the decrypt operation and the subsequent encrypt operation.If your ciphertext was encrypted under an asymmetric CMK, you must use the
SourceKeyId
parameter to identify the CMK that encrypted the ciphertext. You must also supply the encryption algorithm that was used. This information is required to decrypt the data.If your ciphertext was encrypted under a symmetric CMK, the
SourceKeyId
parameter is optional. AWS KMS can get this information from metadata that it adds to the symmetric ciphertext blob. This feature adds durability to your implementation by ensuring that authorized users can decrypt ciphertext decades after it was encrypted, even if they’ve lost track of the CMK ID. However, specifying the source CMK is always recommended as a best practice. When you use theSourceKeyId
parameter to specify a CMK, AWS KMS uses only the CMK you specify. If the ciphertext was encrypted under a different CMK, theReEncrypt
operation fails. This practice ensures that you use the CMK that you intend.To reencrypt the data, you must use the
DestinationKeyId
parameter specify the CMK that re-encrypts the data after it is decrypted. You can select a symmetric or asymmetric CMK. If the destination CMK is an asymmetric CMK, you must also provide the encryption algorithm. The algorithm that you choose must be compatible with the CMK.When you use an asymmetric CMK to encrypt or reencrypt data, be sure to record the CMK and encryption algorithm that you choose. You will be required to provide the same CMK and encryption algorithm when you decrypt the data. If the CMK and algorithm do not match the values used to encrypt the data, the decrypt operation fails.
You are not required to supply the CMK ID and encryption algorithm when you decrypt with symmetric CMKs because AWS KMS stores this information in the ciphertext blob. AWS KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: Yes. The source CMK and destination CMK can be in different AWS accounts. Either or both CMKs can be in a different account than the caller.
Required permissions:
kms:ReEncryptFrom permission on the source CMK (key policy)
kms:ReEncryptTo permission on the destination CMK (key policy)
To permit reencryption from or to a CMK, include the
"kms:ReEncrypt*"
permission in your key policy. This permission is automatically included in the key policy when you use the console to create a CMK. But you must include it manually when you create a CMK programmatically or when you use the PutKeyPolicy operation to set a key policy.Related operations:
See
AWSKMSReEncryptRequest
See
AWSKMSReEncryptResponse
Declaration
Objective-C
- (id)reEncrypt:(nonnull AWSKMSReEncryptRequest *)request;
Swift
func reEncrypt(_ request: AWSKMSReEncryptRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the ReEncrypt service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSKMSReEncryptResponse
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorDisabled
,AWSKMSErrorInvalidCiphertext
,AWSKMSErrorKeyUnavailable
,AWSKMSErrorIncorrectKey
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorInvalidKeyUsage
,AWSKMSErrorInvalidGrantToken
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
. -
Decrypts ciphertext and then reencrypts it entirely within AWS KMS. You can use this operation to change the customer master key (CMK) under which data is encrypted, such as when you manually rotate a CMK or change the CMK that protects a ciphertext. You can also use it to reencrypt ciphertext under the same CMK, such as to change the encryption context of a ciphertext.
The
ReEncrypt
operation can decrypt ciphertext that was encrypted by using an AWS KMS CMK in an AWS KMS operation, such as Encrypt or GenerateDataKey. It can also decrypt ciphertext that was encrypted by using the public key of an asymmetric CMK outside of AWS KMS. However, it cannot decrypt ciphertext produced by other libraries, such as the AWS Encryption SDK or Amazon S3 client-side encryption. These libraries return a ciphertext format that is incompatible with AWS KMS.When you use the
ReEncrypt
operation, you need to provide information for the decrypt operation and the subsequent encrypt operation.If your ciphertext was encrypted under an asymmetric CMK, you must use the
SourceKeyId
parameter to identify the CMK that encrypted the ciphertext. You must also supply the encryption algorithm that was used. This information is required to decrypt the data.If your ciphertext was encrypted under a symmetric CMK, the
SourceKeyId
parameter is optional. AWS KMS can get this information from metadata that it adds to the symmetric ciphertext blob. This feature adds durability to your implementation by ensuring that authorized users can decrypt ciphertext decades after it was encrypted, even if they’ve lost track of the CMK ID. However, specifying the source CMK is always recommended as a best practice. When you use theSourceKeyId
parameter to specify a CMK, AWS KMS uses only the CMK you specify. If the ciphertext was encrypted under a different CMK, theReEncrypt
operation fails. This practice ensures that you use the CMK that you intend.To reencrypt the data, you must use the
DestinationKeyId
parameter specify the CMK that re-encrypts the data after it is decrypted. You can select a symmetric or asymmetric CMK. If the destination CMK is an asymmetric CMK, you must also provide the encryption algorithm. The algorithm that you choose must be compatible with the CMK.When you use an asymmetric CMK to encrypt or reencrypt data, be sure to record the CMK and encryption algorithm that you choose. You will be required to provide the same CMK and encryption algorithm when you decrypt the data. If the CMK and algorithm do not match the values used to encrypt the data, the decrypt operation fails.
You are not required to supply the CMK ID and encryption algorithm when you decrypt with symmetric CMKs because AWS KMS stores this information in the ciphertext blob. AWS KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: Yes. The source CMK and destination CMK can be in different AWS accounts. Either or both CMKs can be in a different account than the caller.
Required permissions:
kms:ReEncryptFrom permission on the source CMK (key policy)
kms:ReEncryptTo permission on the destination CMK (key policy)
To permit reencryption from or to a CMK, include the
"kms:ReEncrypt*"
permission in your key policy. This permission is automatically included in the key policy when you use the console to create a CMK. But you must include it manually when you create a CMK programmatically or when you use the PutKeyPolicy operation to set a key policy.Related operations:
See
AWSKMSReEncryptRequest
See
AWSKMSReEncryptResponse
Declaration
Objective-C
- (void)reEncrypt:(nonnull AWSKMSReEncryptRequest *)request completionHandler:(void (^_Nullable)(AWSKMSReEncryptResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func reEncrypt(_ request: AWSKMSReEncryptRequest, completionHandler: ((AWSKMSReEncryptResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the ReEncrypt service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorDisabled
,AWSKMSErrorInvalidCiphertext
,AWSKMSErrorKeyUnavailable
,AWSKMSErrorIncorrectKey
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorInvalidKeyUsage
,AWSKMSErrorInvalidGrantToken
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
. -
Retires a grant. To clean up, you can retire a grant when you’re done using it. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API:
The AWS account (root user) under which the grant was created
The
RetiringPrincipal
, if present in the grantThe
GranteePrincipal
, ifRetireGrant
is an operation specified in the grant
You must identify the grant to retire by its grant token or by a combination of the grant ID and the Amazon Resource Name (ARN) of the customer master key (CMK). A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. The CreateGrant operation returns both.
Cross-account use: Yes. You can retire a grant on a CMK in a different AWS account.
Required permissions:: Permission to retire a grant is specified in the grant. You cannot control access to this operation in a policy. For more information, see Using grants in the AWS Key Management Service Developer Guide.
Related operations:
See
AWSKMSRetireGrantRequest
Declaration
Objective-C
- (id)retireGrant:(nonnull AWSKMSRetireGrantRequest *)request;
Swift
func retireGrant(_ request: AWSKMSRetireGrantRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the RetireGrant service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorInvalidArn
,AWSKMSErrorInvalidGrantToken
,AWSKMSErrorInvalidGrantId
,AWSKMSErrorNotFound
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
. -
Retires a grant. To clean up, you can retire a grant when you’re done using it. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API:
The AWS account (root user) under which the grant was created
The
RetiringPrincipal
, if present in the grantThe
GranteePrincipal
, ifRetireGrant
is an operation specified in the grant
You must identify the grant to retire by its grant token or by a combination of the grant ID and the Amazon Resource Name (ARN) of the customer master key (CMK). A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. The CreateGrant operation returns both.
Cross-account use: Yes. You can retire a grant on a CMK in a different AWS account.
Required permissions:: Permission to retire a grant is specified in the grant. You cannot control access to this operation in a policy. For more information, see Using grants in the AWS Key Management Service Developer Guide.
Related operations:
See
AWSKMSRetireGrantRequest
Declaration
Objective-C
- (void)retireGrant:(nonnull AWSKMSRetireGrantRequest *)request completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func retireGrant(_ request: AWSKMSRetireGrantRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the RetireGrant service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorInvalidArn
,AWSKMSErrorInvalidGrantToken
,AWSKMSErrorInvalidGrantId
,AWSKMSErrorNotFound
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
. -
Revokes the specified grant for the specified customer master key (CMK). You can revoke a grant to actively deny operations that depend on it.
Cross-account use: Yes. To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the
KeyId
parameter.Required permissions: kms:RevokeGrant (key policy)
Related operations:
See
AWSKMSRevokeGrantRequest
Declaration
Objective-C
- (id)revokeGrant:(nonnull AWSKMSRevokeGrantRequest *)request;
Swift
func revokeGrant(_ request: AWSKMSRevokeGrantRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the RevokeGrant service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorInvalidArn
,AWSKMSErrorInvalidGrantId
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
. -
Revokes the specified grant for the specified customer master key (CMK). You can revoke a grant to actively deny operations that depend on it.
Cross-account use: Yes. To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the
KeyId
parameter.Required permissions: kms:RevokeGrant (key policy)
Related operations:
See
AWSKMSRevokeGrantRequest
Declaration
Objective-C
- (void)revokeGrant:(nonnull AWSKMSRevokeGrantRequest *)request completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func revokeGrant(_ request: AWSKMSRevokeGrantRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the RevokeGrant service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorInvalidArn
,AWSKMSErrorInvalidGrantId
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
. -
Schedules the deletion of a customer master key (CMK). You may provide a waiting period, specified in days, before deletion occurs. If you do not provide a waiting period, the default period of 30 days is used. When this operation is successful, the key state of the CMK changes to
PendingDeletion
. Before the waiting period ends, you can use CancelKeyDeletion to cancel the deletion of the CMK. After the waiting period ends, AWS KMS deletes the CMK and all AWS KMS data associated with it, including all aliases that refer to it.Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is unrecoverable. To prevent the use of a CMK without deleting it, use DisableKey.
If you schedule deletion of a CMK from a custom key store, when the waiting period expires,
ScheduleKeyDeletion
deletes the CMK from AWS KMS. Then AWS KMS makes a best effort to delete the key material from the associated AWS CloudHSM cluster. However, you might need to manually delete the orphaned key material from the cluster and its backups.For more information about scheduling a CMK for deletion, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.
Required permissions: kms:ScheduleKeyDeletion (key policy)
Related operations
See
AWSKMSScheduleKeyDeletionRequest
See
AWSKMSScheduleKeyDeletionResponse
Declaration
Objective-C
- (id)scheduleKeyDeletion:(nonnull AWSKMSScheduleKeyDeletionRequest *)request;
Swift
func scheduleKeyDeletion(_ request: AWSKMSScheduleKeyDeletionRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the ScheduleKeyDeletion service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSKMSScheduleKeyDeletionResponse
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorInvalidArn
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
. -
Schedules the deletion of a customer master key (CMK). You may provide a waiting period, specified in days, before deletion occurs. If you do not provide a waiting period, the default period of 30 days is used. When this operation is successful, the key state of the CMK changes to
PendingDeletion
. Before the waiting period ends, you can use CancelKeyDeletion to cancel the deletion of the CMK. After the waiting period ends, AWS KMS deletes the CMK and all AWS KMS data associated with it, including all aliases that refer to it.Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is unrecoverable. To prevent the use of a CMK without deleting it, use DisableKey.
If you schedule deletion of a CMK from a custom key store, when the waiting period expires,
ScheduleKeyDeletion
deletes the CMK from AWS KMS. Then AWS KMS makes a best effort to delete the key material from the associated AWS CloudHSM cluster. However, you might need to manually delete the orphaned key material from the cluster and its backups.For more information about scheduling a CMK for deletion, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.
Required permissions: kms:ScheduleKeyDeletion (key policy)
Related operations
See
AWSKMSScheduleKeyDeletionRequest
See
AWSKMSScheduleKeyDeletionResponse
Declaration
Objective-C
- (void)scheduleKeyDeletion:(nonnull AWSKMSScheduleKeyDeletionRequest *)request completionHandler: (void (^_Nullable)(AWSKMSScheduleKeyDeletionResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func scheduleKeyDeletion(_ request: AWSKMSScheduleKeyDeletionRequest, completionHandler: ((AWSKMSScheduleKeyDeletionResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the ScheduleKeyDeletion service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorInvalidArn
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
. -
Creates a digital signature for a message or message digest by using the private key in an asymmetric CMK. To verify the signature, use the Verify operation, or use the public key in the same asymmetric CMK outside of AWS KMS. For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
Digital signatures are generated and verified by using asymmetric key pair, such as an RSA or ECC pair that is represented by an asymmetric customer master key (CMK). The key owner (or an authorized user) uses their private key to sign a message. Anyone with the public key can verify that the message was signed with that particular private key and that the message hasn’t changed since it was signed.
To use the
Sign
operation, provide the following information:Use the
KeyId
parameter to identify an asymmetric CMK with aKeyUsage
value ofSIGN_VERIFY
. To get theKeyUsage
value of a CMK, use the DescribeKey operation. The caller must havekms:Sign
permission on the CMK.Use the
Message
parameter to specify the message or message digest to sign. You can submit messages of up to 4096 bytes. To sign a larger message, generate a hash digest of the message, and then provide the hash digest in theMessage
parameter. To indicate whether the message is a full message or a digest, use theMessageType
parameter.Choose a signing algorithm that is compatible with the CMK.
When signing a message, be sure to record the CMK and the signing algorithm. This information is required to verify the signature.
To verify the signature that this operation generates, use the Verify operation. Or use the GetPublicKey operation to download the public key and then use the public key to verify the signature outside of AWS KMS.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the
KeyId
parameter.Required permissions: kms:Sign (key policy)
Related operations: Verify
See
AWSKMSSignRequest
See
AWSKMSSignResponse
Declaration
Objective-C
- (id)sign:(nonnull AWSKMSSignRequest *)request;
Swift
func sign(_ request: AWSKMSSignRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the Sign service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSKMSSignResponse
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorDisabled
,AWSKMSErrorKeyUnavailable
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorInvalidKeyUsage
,AWSKMSErrorInvalidGrantToken
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
. -
Creates a digital signature for a message or message digest by using the private key in an asymmetric CMK. To verify the signature, use the Verify operation, or use the public key in the same asymmetric CMK outside of AWS KMS. For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
Digital signatures are generated and verified by using asymmetric key pair, such as an RSA or ECC pair that is represented by an asymmetric customer master key (CMK). The key owner (or an authorized user) uses their private key to sign a message. Anyone with the public key can verify that the message was signed with that particular private key and that the message hasn’t changed since it was signed.
To use the
Sign
operation, provide the following information:Use the
KeyId
parameter to identify an asymmetric CMK with aKeyUsage
value ofSIGN_VERIFY
. To get theKeyUsage
value of a CMK, use the DescribeKey operation. The caller must havekms:Sign
permission on the CMK.Use the
Message
parameter to specify the message or message digest to sign. You can submit messages of up to 4096 bytes. To sign a larger message, generate a hash digest of the message, and then provide the hash digest in theMessage
parameter. To indicate whether the message is a full message or a digest, use theMessageType
parameter.Choose a signing algorithm that is compatible with the CMK.
When signing a message, be sure to record the CMK and the signing algorithm. This information is required to verify the signature.
To verify the signature that this operation generates, use the Verify operation. Or use the GetPublicKey operation to download the public key and then use the public key to verify the signature outside of AWS KMS.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the
KeyId
parameter.Required permissions: kms:Sign (key policy)
Related operations: Verify
See
AWSKMSSignRequest
See
AWSKMSSignResponse
Declaration
Objective-C
- (void)sign:(nonnull AWSKMSSignRequest *)request completionHandler:(void (^_Nullable)(AWSKMSSignResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func sign(_ request: AWSKMSSignRequest, completionHandler: ((AWSKMSSignResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the Sign service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorDisabled
,AWSKMSErrorKeyUnavailable
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorInvalidKeyUsage
,AWSKMSErrorInvalidGrantToken
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
. -
Adds or edits tags on a customer managed CMK.
Each tag consists of a tag key and a tag value, both of which are case-sensitive strings. The tag value can be an empty (null) string.
To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag key and a new tag value.
You can use this operation to tag a customer managed CMK, but you cannot tag an AWS managed CMK, an AWS owned CMK, or an alias.
For general information about tags, including the format and syntax, see Tagging AWS resources in the Amazon Web Services General Reference. For information about using tags in AWS KMS, see Tagging keys.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.
Required permissions: kms:TagResource (key policy)
Related operations
See
AWSKMSTagResourceRequest
Declaration
Objective-C
- (id)tagResource:(nonnull AWSKMSTagResourceRequest *)request;
Swift
func tagResource(_ request: AWSKMSTagResourceRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the TagResource service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorKMSInternal
,AWSKMSErrorNotFound
,AWSKMSErrorInvalidArn
,AWSKMSErrorKMSInvalidState
,AWSKMSErrorLimitExceeded
,AWSKMSErrorTag
. -
Adds or edits tags on a customer managed CMK.
Each tag consists of a tag key and a tag value, both of which are case-sensitive strings. The tag value can be an empty (null) string.
To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag key and a new tag value.
You can use this operation to tag a customer managed CMK, but you cannot tag an AWS managed CMK, an AWS owned CMK, or an alias.
For general information about tags, including the format and syntax, see Tagging AWS resources in the Amazon Web Services General Reference. For information about using tags in AWS KMS, see Tagging keys.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.
Required permissions: kms:TagResource (key policy)
Related operations
See
AWSKMSTagResourceRequest
Declaration
Objective-C
- (void)tagResource:(nonnull AWSKMSTagResourceRequest *)request completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func tagResource(_ request: AWSKMSTagResourceRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the TagResource service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorKMSInternal
,AWSKMSErrorNotFound
,AWSKMSErrorInvalidArn
,AWSKMSErrorKMSInvalidState
,AWSKMSErrorLimitExceeded
,AWSKMSErrorTag
. -
Deletes tags from a customer managed CMK. To delete a tag, specify the tag key and the CMK.
When it succeeds, the
UntagResource
operation doesn’t return any output. Also, if the specified tag key isn’t found on the CMK, it doesn’t throw an exception or return a response. To confirm that the operation worked, use the ListResourceTags operation.For general information about tags, including the format and syntax, see Tagging AWS resources in the Amazon Web Services General Reference. For information about using tags in AWS KMS, see Tagging keys.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.
Required permissions: kms:UntagResource (key policy)
Related operations
See
AWSKMSUntagResourceRequest
Declaration
Objective-C
- (id)untagResource:(nonnull AWSKMSUntagResourceRequest *)request;
Swift
func untagResource(_ request: AWSKMSUntagResourceRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the UntagResource service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorKMSInternal
,AWSKMSErrorNotFound
,AWSKMSErrorInvalidArn
,AWSKMSErrorKMSInvalidState
,AWSKMSErrorTag
. -
Deletes tags from a customer managed CMK. To delete a tag, specify the tag key and the CMK.
When it succeeds, the
UntagResource
operation doesn’t return any output. Also, if the specified tag key isn’t found on the CMK, it doesn’t throw an exception or return a response. To confirm that the operation worked, use the ListResourceTags operation.For general information about tags, including the format and syntax, see Tagging AWS resources in the Amazon Web Services General Reference. For information about using tags in AWS KMS, see Tagging keys.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.
Required permissions: kms:UntagResource (key policy)
Related operations
See
AWSKMSUntagResourceRequest
Declaration
Objective-C
- (void)untagResource:(nonnull AWSKMSUntagResourceRequest *)request completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func untagResource(_ request: AWSKMSUntagResourceRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the UntagResource service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorKMSInternal
,AWSKMSErrorNotFound
,AWSKMSErrorInvalidArn
,AWSKMSErrorKMSInvalidState
,AWSKMSErrorTag
. -
Associates an existing AWS KMS alias with a different customer master key (CMK). Each alias is associated with only one CMK at a time, although a CMK can have multiple aliases. The alias and the CMK must be in the same AWS account and region.
The current and new CMK must be the same type (both symmetric or both asymmetric), and they must have the same key usage (
ENCRYPT_DECRYPT
orSIGN_VERIFY
). This restriction prevents errors in code that uses aliases. If you must assign an alias to a different type of CMK, use DeleteAlias to delete the old alias and CreateAlias to create a new alias.You cannot use
UpdateAlias
to change an alias name. To change an alias name, use DeleteAlias to delete the old alias and CreateAlias to create a new alias.Because an alias is not a property of a CMK, you can create, update, and delete the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs in the account, use the ListAliases operation.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.
Required permissions
kms:UpdateAlias on the alias (IAM policy).
kms:UpdateAlias on the current CMK (key policy).
kms:UpdateAlias on the new CMK (key policy).
For details, see Controlling access to aliases in the AWS Key Management Service Developer Guide.
Related operations:
See
AWSKMSUpdateAliasRequest
Declaration
Objective-C
- (id)updateAlias:(nonnull AWSKMSUpdateAliasRequest *)request;
Swift
func updateAlias(_ request: AWSKMSUpdateAliasRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the UpdateAlias service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorDependencyTimeout
,AWSKMSErrorNotFound
,AWSKMSErrorKMSInternal
,AWSKMSErrorLimitExceeded
,AWSKMSErrorKMSInvalidState
. -
Associates an existing AWS KMS alias with a different customer master key (CMK). Each alias is associated with only one CMK at a time, although a CMK can have multiple aliases. The alias and the CMK must be in the same AWS account and region.
The current and new CMK must be the same type (both symmetric or both asymmetric), and they must have the same key usage (
ENCRYPT_DECRYPT
orSIGN_VERIFY
). This restriction prevents errors in code that uses aliases. If you must assign an alias to a different type of CMK, use DeleteAlias to delete the old alias and CreateAlias to create a new alias.You cannot use
UpdateAlias
to change an alias name. To change an alias name, use DeleteAlias to delete the old alias and CreateAlias to create a new alias.Because an alias is not a property of a CMK, you can create, update, and delete the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs in the account, use the ListAliases operation.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.
Required permissions
kms:UpdateAlias on the alias (IAM policy).
kms:UpdateAlias on the current CMK (key policy).
kms:UpdateAlias on the new CMK (key policy).
For details, see Controlling access to aliases in the AWS Key Management Service Developer Guide.
Related operations:
See
AWSKMSUpdateAliasRequest
Declaration
Objective-C
- (void)updateAlias:(nonnull AWSKMSUpdateAliasRequest *)request completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func updateAlias(_ request: AWSKMSUpdateAliasRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the UpdateAlias service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorDependencyTimeout
,AWSKMSErrorNotFound
,AWSKMSErrorKMSInternal
,AWSKMSErrorLimitExceeded
,AWSKMSErrorKMSInvalidState
. -
Changes the properties of a custom key store. Use the
CustomKeyStoreId
parameter to identify the custom key store you want to edit. Use the remaining parameters to change the properties of the custom key store.You can only update a custom key store that is disconnected. To disconnect the custom key store, use DisconnectCustomKeyStore. To reconnect the custom key store after the update completes, use ConnectCustomKeyStore. To find the connection state of a custom key store, use the DescribeCustomKeyStores operation.
Use the parameters of
UpdateCustomKeyStore
to edit your keystore settings.Use the NewCustomKeyStoreName parameter to change the friendly name of the custom key store to the value that you specify.
Use the KeyStorePassword parameter tell AWS KMS the current password of the
kmsuser
crypto user (CU) in the associated AWS CloudHSM cluster. You can use this parameter to fix connection failures that occur when AWS KMS cannot log into the associated cluster because thekmsuser
password has changed. This value does not change the password in the AWS CloudHSM cluster.Use the CloudHsmClusterId parameter to associate the custom key store with a different, but related, AWS CloudHSM cluster. You can use this parameter to repair a custom key store if its AWS CloudHSM cluster becomes corrupted or is deleted, or when you need to create or restore a cluster from a backup.
If the operation succeeds, it returns a JSON object with no properties.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
Cross-account use: No. You cannot perform this operation on a custom key store in a different AWS account.
Required permissions: kms:UpdateCustomKeyStore (IAM policy)
Related operations:
See
AWSKMSUpdateCustomKeyStoreRequest
See
AWSKMSUpdateCustomKeyStoreResponse
Declaration
Objective-C
- (id)updateCustomKeyStore:(nonnull AWSKMSUpdateCustomKeyStoreRequest *)request;
Swift
func updateCustomKeyStore(_ request: AWSKMSUpdateCustomKeyStoreRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the UpdateCustomKeyStore service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSKMSUpdateCustomKeyStoreResponse
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorCustomKeyStoreNotFound
,AWSKMSErrorCustomKeyStoreNameInUse
,AWSKMSErrorCloudHsmClusterNotFound
,AWSKMSErrorCloudHsmClusterNotRelated
,AWSKMSErrorCustomKeyStoreInvalidState
,AWSKMSErrorKMSInternal
,AWSKMSErrorCloudHsmClusterNotActive
,AWSKMSErrorCloudHsmClusterInvalidConfiguration
. -
Changes the properties of a custom key store. Use the
CustomKeyStoreId
parameter to identify the custom key store you want to edit. Use the remaining parameters to change the properties of the custom key store.You can only update a custom key store that is disconnected. To disconnect the custom key store, use DisconnectCustomKeyStore. To reconnect the custom key store after the update completes, use ConnectCustomKeyStore. To find the connection state of a custom key store, use the DescribeCustomKeyStores operation.
Use the parameters of
UpdateCustomKeyStore
to edit your keystore settings.Use the NewCustomKeyStoreName parameter to change the friendly name of the custom key store to the value that you specify.
Use the KeyStorePassword parameter tell AWS KMS the current password of the
kmsuser
crypto user (CU) in the associated AWS CloudHSM cluster. You can use this parameter to fix connection failures that occur when AWS KMS cannot log into the associated cluster because thekmsuser
password has changed. This value does not change the password in the AWS CloudHSM cluster.Use the CloudHsmClusterId parameter to associate the custom key store with a different, but related, AWS CloudHSM cluster. You can use this parameter to repair a custom key store if its AWS CloudHSM cluster becomes corrupted or is deleted, or when you need to create or restore a cluster from a backup.
If the operation succeeds, it returns a JSON object with no properties.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.
Cross-account use: No. You cannot perform this operation on a custom key store in a different AWS account.
Required permissions: kms:UpdateCustomKeyStore (IAM policy)
Related operations:
See
AWSKMSUpdateCustomKeyStoreRequest
See
AWSKMSUpdateCustomKeyStoreResponse
Declaration
Objective-C
- (void)updateCustomKeyStore: (nonnull AWSKMSUpdateCustomKeyStoreRequest *)request completionHandler: (void (^_Nullable)(AWSKMSUpdateCustomKeyStoreResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func updateCustomKeyStore(_ request: AWSKMSUpdateCustomKeyStoreRequest, completionHandler: ((AWSKMSUpdateCustomKeyStoreResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the UpdateCustomKeyStore service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorCustomKeyStoreNotFound
,AWSKMSErrorCustomKeyStoreNameInUse
,AWSKMSErrorCloudHsmClusterNotFound
,AWSKMSErrorCloudHsmClusterNotRelated
,AWSKMSErrorCustomKeyStoreInvalidState
,AWSKMSErrorKMSInternal
,AWSKMSErrorCloudHsmClusterNotActive
,AWSKMSErrorCloudHsmClusterInvalidConfiguration
. -
Updates the description of a customer master key (CMK). To see the description of a CMK, use DescribeKey.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.
Required permissions: kms:UpdateKeyDescription (key policy)
Related operations
See
AWSKMSUpdateKeyDescriptionRequest
Declaration
Objective-C
- (id)updateKeyDescription:(nonnull AWSKMSUpdateKeyDescriptionRequest *)request;
Swift
func updateKeyDescription(_ request: AWSKMSUpdateKeyDescriptionRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the UpdateKeyDescription service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorInvalidArn
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
. -
Updates the description of a customer master key (CMK). To see the description of a CMK, use DescribeKey.
The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.
Required permissions: kms:UpdateKeyDescription (key policy)
Related operations
See
AWSKMSUpdateKeyDescriptionRequest
Declaration
Objective-C
- (void)updateKeyDescription: (nonnull AWSKMSUpdateKeyDescriptionRequest *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func updateKeyDescription(_ request: AWSKMSUpdateKeyDescriptionRequest, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the UpdateKeyDescription service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorInvalidArn
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
. -
Verifies a digital signature that was generated by the Sign operation.
Verification confirms that an authorized user signed the message with the specified CMK and signing algorithm, and the message hasn’t changed since it was signed. If the signature is verified, the value of the
SignatureValid
field in the response isTrue
. If the signature verification fails, theVerify
operation fails with anKMSInvalidSignatureException
exception.A digital signature is generated by using the private key in an asymmetric CMK. The signature is verified by using the public key in the same asymmetric CMK. For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
To verify a digital signature, you can use the
Verify
operation. Specify the same asymmetric CMK, message, and signing algorithm that were used to produce the signature.You can also verify the digital signature by using the public key of the CMK outside of AWS KMS. Use the GetPublicKey operation to download the public key in the asymmetric CMK and then use the public key to verify the signature outside of AWS KMS. The advantage of using the
Verify
operation is that it is performed within AWS KMS. As a result, it’s easy to call, the operation is performed within the FIPS boundary, it is logged in AWS CloudTrail, and you can use key policy and IAM policy to determine who is authorized to use the CMK to verify signatures.The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the
KeyId
parameter.Required permissions: kms:Verify (key policy)
Related operations: Sign
See
AWSKMSVerifyRequest
See
AWSKMSVerifyResponse
Declaration
Objective-C
- (id)verify:(nonnull AWSKMSVerifyRequest *)request;
Swift
func verify(_ request: AWSKMSVerifyRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the Verify service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSKMSVerifyResponse
. On failed execution,task.error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorDisabled
,AWSKMSErrorKeyUnavailable
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorInvalidKeyUsage
,AWSKMSErrorInvalidGrantToken
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
,AWSKMSErrorKMSInvalidSignature
. -
Verifies a digital signature that was generated by the Sign operation.
Verification confirms that an authorized user signed the message with the specified CMK and signing algorithm, and the message hasn’t changed since it was signed. If the signature is verified, the value of the
SignatureValid
field in the response isTrue
. If the signature verification fails, theVerify
operation fails with anKMSInvalidSignatureException
exception.A digital signature is generated by using the private key in an asymmetric CMK. The signature is verified by using the public key in the same asymmetric CMK. For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.
To verify a digital signature, you can use the
Verify
operation. Specify the same asymmetric CMK, message, and signing algorithm that were used to produce the signature.You can also verify the digital signature by using the public key of the CMK outside of AWS KMS. Use the GetPublicKey operation to download the public key in the asymmetric CMK and then use the public key to verify the signature outside of AWS KMS. The advantage of using the
Verify
operation is that it is performed within AWS KMS. As a result, it’s easy to call, the operation is performed within the FIPS boundary, it is logged in AWS CloudTrail, and you can use key policy and IAM policy to determine who is authorized to use the CMK to verify signatures.The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Cross-account use: Yes. To perform this operation with a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the
KeyId
parameter.Required permissions: kms:Verify (key policy)
Related operations: Sign
See
AWSKMSVerifyRequest
See
AWSKMSVerifyResponse
Declaration
Objective-C
- (void)verify:(nonnull AWSKMSVerifyRequest *)request completionHandler:(void (^_Nullable)(AWSKMSVerifyResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func verify(_ request: AWSKMSVerifyRequest, completionHandler: ((AWSKMSVerifyResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the Verify service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSKMSErrorDomain
domain and the following error code:AWSKMSErrorNotFound
,AWSKMSErrorDisabled
,AWSKMSErrorKeyUnavailable
,AWSKMSErrorDependencyTimeout
,AWSKMSErrorInvalidKeyUsage
,AWSKMSErrorInvalidGrantToken
,AWSKMSErrorKMSInternal
,AWSKMSErrorKMSInvalidState
,AWSKMSErrorKMSInvalidSignature
.