AWSKMS Class Reference

Inherits from AWSService : NSObject
Declared in AWSKMSService.h
AWSKMSService.m

Overview

AWS Key Management Service

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, iOS, 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, or you can 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:

Commonly Used APIs

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

  configuration

The service configuration used to instantiate this service client.

@property (nonatomic, strong, readonly) AWSServiceConfiguration *configuration

Discussion

Warning: Once the client is instantiated, do not modify the configuration object. It may cause unspecified behaviors.

Declared In

AWSKMSService.h

+ defaultKMS

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.

+ (instancetype)defaultKMS

Return Value

The default service client.

Discussion

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

Declared In

AWSKMSService.h

+ registerKMSWithConfiguration:forKey:

Creates a service client with the given service configuration and registers it for the key.

+ (void)registerKMSWithConfiguration:(AWSServiceConfiguration *)configuration forKey:(NSString *)key

Parameters

configuration

A service configuration object.

key

A string to identify the service client.

Discussion

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.

Declared In

AWSKMSService.h

+ KMSForKey:

Retrieves the service client associated with the key. You need to call + registerKMSWithConfiguration:forKey: before invoking this method.

+ (instancetype)KMSForKey:(NSString *)key

Parameters

key

A string to identify the service client.

Return Value

An instance of the service client.

Discussion

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"];

Declared In

AWSKMSService.h

+ removeKMSForKey:

Removes the service client associated with the key and release it.

+ (void)removeKMSForKey:(NSString *)key

Parameters

key

A string to identify the service client.

Discussion

Warning: Before calling this method, make sure no method is running on this client.

Declared In

AWSKMSService.h

– cancelKeyDeletion:

Cancels the deletion of a customer master key (CMK). When this operation is successful, the CMK is set to the Disabled state. To enable a 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.

- (AWSTask<AWSKMSCancelKeyDeletionResponse*> *)cancelKeyDeletion:(AWSKMSCancelKeyDeletionRequest *)request

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 of AWSKMSCancelKeyDeletionResponse. On failed execution, task.error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorNotFound, AWSKMSErrorInvalidArn, AWSKMSErrorDependencyTimeout, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidState.

Declared In

AWSKMSService.h

– cancelKeyDeletion:completionHandler:

Cancels the deletion of a customer master key (CMK). When this operation is successful, the CMK is set to the Disabled state. To enable a 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.

- (void)cancelKeyDeletion:(AWSKMSCancelKeyDeletionRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSKMSCancelKeyDeletionResponse *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorNotFound, AWSKMSErrorInvalidArn, AWSKMSErrorDependencyTimeout, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidState.

Declared In

AWSKMSService.h

– createAlias:

Creates a display name for a customer master key. An alias can be used to identify a key and should be unique. The console enforces a one-to-one mapping between the alias and a key. An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word "alias" followed by a forward slash (alias/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS).

The alias and the key it is mapped to must be in the same AWS account and the same region.

To map an alias to a different key, call UpdateAlias.

- (AWSTask *)createAlias:(AWSKMSCreateAliasRequest *)request

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 be nil. On failed execution, task.error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorDependencyTimeout, AWSKMSErrorAlreadyExists, AWSKMSErrorNotFound, AWSKMSErrorInvalidAliasName, AWSKMSErrorKMSInternal, AWSKMSErrorLimitExceeded, AWSKMSErrorKMSInvalidState.

Declared In

AWSKMSService.h

– createAlias:completionHandler:

Creates a display name for a customer master key. An alias can be used to identify a key and should be unique. The console enforces a one-to-one mapping between the alias and a key. An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word "alias" followed by a forward slash (alias/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS).

The alias and the key it is mapped to must be in the same AWS account and the same region.

To map an alias to a different key, call UpdateAlias.

- (void)createAlias:(AWSKMSCreateAliasRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorDependencyTimeout, AWSKMSErrorAlreadyExists, AWSKMSErrorNotFound, AWSKMSErrorInvalidAliasName, AWSKMSErrorKMSInternal, AWSKMSErrorLimitExceeded, AWSKMSErrorKMSInvalidState.

Declared In

AWSKMSService.h

– createGrant:

Adds a grant to a key to specify who can use the key and under what conditions. Grants are alternate permission mechanisms to key policies.

For more information about grants, see Grants in the AWS Key Management Service Developer Guide.

- (AWSTask<AWSKMSCreateGrantResponse*> *)createGrant:(AWSKMSCreateGrantRequest *)request

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 of AWSKMSCreateGrantResponse. On failed execution, task.error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorNotFound, AWSKMSErrorDisabled, AWSKMSErrorDependencyTimeout, AWSKMSErrorInvalidArn, AWSKMSErrorKMSInternal, AWSKMSErrorInvalidGrantToken, AWSKMSErrorLimitExceeded, AWSKMSErrorKMSInvalidState.

Declared In

AWSKMSService.h

– createGrant:completionHandler:

Adds a grant to a key to specify who can use the key and under what conditions. Grants are alternate permission mechanisms to key policies.

For more information about grants, see Grants in the AWS Key Management Service Developer Guide.

- (void)createGrant:(AWSKMSCreateGrantRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSKMSCreateGrantResponse *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorNotFound, AWSKMSErrorDisabled, AWSKMSErrorDependencyTimeout, AWSKMSErrorInvalidArn, AWSKMSErrorKMSInternal, AWSKMSErrorInvalidGrantToken, AWSKMSErrorLimitExceeded, AWSKMSErrorKMSInvalidState.

Declared In

AWSKMSService.h

– createKey:

Creates a customer master key (CMK).

You can use a CMK to encrypt small amounts of data (4 KiB or less) directly, but CMKs are more commonly used to encrypt data encryption keys (DEKs), which are used to encrypt raw data. For more information about DEKs and the difference between CMKs and DEKs, see the following:

- (AWSTask<AWSKMSCreateKeyResponse*> *)createKey:(AWSKMSCreateKeyRequest *)request

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 of AWSKMSCreateKeyResponse. On failed execution, task.error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorMalformedPolicyDocument, AWSKMSErrorDependencyTimeout, AWSKMSErrorInvalidArn, AWSKMSErrorUnsupportedOperation, AWSKMSErrorKMSInternal, AWSKMSErrorLimitExceeded, AWSKMSErrorTag.

Declared In

AWSKMSService.h

– createKey:completionHandler:

Creates a customer master key (CMK).

You can use a CMK to encrypt small amounts of data (4 KiB or less) directly, but CMKs are more commonly used to encrypt data encryption keys (DEKs), which are used to encrypt raw data. For more information about DEKs and the difference between CMKs and DEKs, see the following:

- (void)createKey:(AWSKMSCreateKeyRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSKMSCreateKeyResponse *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorMalformedPolicyDocument, AWSKMSErrorDependencyTimeout, AWSKMSErrorInvalidArn, AWSKMSErrorUnsupportedOperation, AWSKMSErrorKMSInternal, AWSKMSErrorLimitExceeded, AWSKMSErrorTag.

Declared In

AWSKMSService.h

– decrypt:

Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using any of the following functions:

Note that if a caller has been granted access permissions to all keys (through, for example, IAM user policies that grant Decrypt permission on all resources), then ciphertext encrypted by using keys in other accounts where the key grants access to the caller can be decrypted. To remedy this, we recommend that you do not grant Decrypt access in an IAM user policy. Instead grant Decrypt access only in key policies. If you must grant Decrypt access in an IAM user policy, you should scope the resource to specific keys or to specific trusted accounts.

- (AWSTask<AWSKMSDecryptResponse*> *)decrypt:(AWSKMSDecryptRequest *)request

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 of AWSKMSDecryptResponse. On failed execution, task.error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorNotFound, AWSKMSErrorDisabled, AWSKMSErrorInvalidCiphertext, AWSKMSErrorKeyUnavailable, AWSKMSErrorDependencyTimeout, AWSKMSErrorInvalidGrantToken, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidState.

Declared In

AWSKMSService.h

– decrypt:completionHandler:

Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using any of the following functions:

Note that if a caller has been granted access permissions to all keys (through, for example, IAM user policies that grant Decrypt permission on all resources), then ciphertext encrypted by using keys in other accounts where the key grants access to the caller can be decrypted. To remedy this, we recommend that you do not grant Decrypt access in an IAM user policy. Instead grant Decrypt access only in key policies. If you must grant Decrypt access in an IAM user policy, you should scope the resource to specific keys or to specific trusted accounts.

- (void)decrypt:(AWSKMSDecryptRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSKMSDecryptResponse *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorNotFound, AWSKMSErrorDisabled, AWSKMSErrorInvalidCiphertext, AWSKMSErrorKeyUnavailable, AWSKMSErrorDependencyTimeout, AWSKMSErrorInvalidGrantToken, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidState.

Declared In

AWSKMSService.h

– deleteAlias:

Deletes the specified alias. To map an alias to a different key, call UpdateAlias.

- (AWSTask *)deleteAlias:(AWSKMSDeleteAliasRequest *)request

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 be nil. On failed execution, task.error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorDependencyTimeout, AWSKMSErrorNotFound, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidState.

Declared In

AWSKMSService.h

– deleteAlias:completionHandler:

Deletes the specified alias. To map an alias to a different key, call UpdateAlias.

- (void)deleteAlias:(AWSKMSDeleteAliasRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorDependencyTimeout, AWSKMSErrorNotFound, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidState.

Declared In

AWSKMSService.h

– deleteImportedKeyMaterial:

Deletes key material that you previously imported and 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 to PendingImport.

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

- (AWSTask *)deleteImportedKeyMaterial:(AWSKMSDeleteImportedKeyMaterialRequest *)request

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 be nil. On failed execution, task.error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorInvalidArn, AWSKMSErrorUnsupportedOperation, AWSKMSErrorDependencyTimeout, AWSKMSErrorNotFound, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidState.

Declared In

AWSKMSService.h

– deleteImportedKeyMaterial:completionHandler:

Deletes key material that you previously imported and 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 to PendingImport.

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

- (void)deleteImportedKeyMaterial:(AWSKMSDeleteImportedKeyMaterialRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorInvalidArn, AWSKMSErrorUnsupportedOperation, AWSKMSErrorDependencyTimeout, AWSKMSErrorNotFound, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidState.

Declared In

AWSKMSService.h

– describeKey:

Provides detailed information about the specified customer master key.

- (AWSTask<AWSKMSDescribeKeyResponse*> *)describeKey:(AWSKMSDescribeKeyRequest *)request

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 of AWSKMSDescribeKeyResponse. On failed execution, task.error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorNotFound, AWSKMSErrorInvalidArn, AWSKMSErrorDependencyTimeout, AWSKMSErrorKMSInternal.

Declared In

AWSKMSService.h

– describeKey:completionHandler:

Provides detailed information about the specified customer master key.

- (void)describeKey:(AWSKMSDescribeKeyRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSKMSDescribeKeyResponse *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorNotFound, AWSKMSErrorInvalidArn, AWSKMSErrorDependencyTimeout, AWSKMSErrorKMSInternal.

Declared In

AWSKMSService.h

– disableKey:

Sets the state of a customer master key (CMK) to disabled, thereby preventing its use 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.

- (AWSTask *)disableKey:(AWSKMSDisableKeyRequest *)request

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 be nil. On failed execution, task.error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorNotFound, AWSKMSErrorInvalidArn, AWSKMSErrorDependencyTimeout, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidState.

Declared In

AWSKMSService.h

– disableKey:completionHandler:

Sets the state of a customer master key (CMK) to disabled, thereby preventing its use 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.

- (void)disableKey:(AWSKMSDisableKeyRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorNotFound, AWSKMSErrorInvalidArn, AWSKMSErrorDependencyTimeout, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidState.

Declared In

AWSKMSService.h

– disableKeyRotation:

Disables rotation of the specified key.

- (AWSTask *)disableKeyRotation:(AWSKMSDisableKeyRotationRequest *)request

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 be nil. On failed execution, task.error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorNotFound, AWSKMSErrorDisabled, AWSKMSErrorInvalidArn, AWSKMSErrorDependencyTimeout, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidState, AWSKMSErrorUnsupportedOperation.

Declared In

AWSKMSService.h

– disableKeyRotation:completionHandler:

Disables rotation of the specified key.

- (void)disableKeyRotation:(AWSKMSDisableKeyRotationRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorNotFound, AWSKMSErrorDisabled, AWSKMSErrorInvalidArn, AWSKMSErrorDependencyTimeout, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidState, AWSKMSErrorUnsupportedOperation.

Declared In

AWSKMSService.h

– enableKey:

Marks a key as enabled, thereby permitting its use.

- (AWSTask *)enableKey:(AWSKMSEnableKeyRequest *)request

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 be nil. On failed execution, task.error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorNotFound, AWSKMSErrorInvalidArn, AWSKMSErrorDependencyTimeout, AWSKMSErrorKMSInternal, AWSKMSErrorLimitExceeded, AWSKMSErrorKMSInvalidState.

Declared In

AWSKMSService.h

– enableKey:completionHandler:

Marks a key as enabled, thereby permitting its use.

- (void)enableKey:(AWSKMSEnableKeyRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorNotFound, AWSKMSErrorInvalidArn, AWSKMSErrorDependencyTimeout, AWSKMSErrorKMSInternal, AWSKMSErrorLimitExceeded, AWSKMSErrorKMSInvalidState.

Declared In

AWSKMSService.h

– enableKeyRotation:

Enables rotation of the specified customer master key.

- (AWSTask *)enableKeyRotation:(AWSKMSEnableKeyRotationRequest *)request

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 be nil. On failed execution, task.error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorNotFound, AWSKMSErrorDisabled, AWSKMSErrorInvalidArn, AWSKMSErrorDependencyTimeout, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidState, AWSKMSErrorUnsupportedOperation.

Declared In

AWSKMSService.h

– enableKeyRotation:completionHandler:

Enables rotation of the specified customer master key.

- (void)enableKeyRotation:(AWSKMSEnableKeyRotationRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorNotFound, AWSKMSErrorDisabled, AWSKMSErrorInvalidArn, AWSKMSErrorDependencyTimeout, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidState, AWSKMSErrorUnsupportedOperation.

Declared In

AWSKMSService.h

– encrypt:

Encrypts plaintext into ciphertext by using a customer master key. The Encrypt function has two primary use cases:

  • You can encrypt up to 4 KB of arbitrary data such as an RSA key, a database password, or other sensitive customer information.

  • If you are moving encrypted data from one region to another, you can use this API to encrypt in the new region the plaintext data key that was used to encrypt the data in the original region. This provides you with an encrypted copy of the data key that can be decrypted in the new region and used there to decrypt the encrypted data.

Unless you are moving encrypted data from one region to another, you don't use this function to encrypt a generated data key within a region. You retrieve data keys already encrypted by calling the GenerateDataKey or GenerateDataKeyWithoutPlaintext function. Data keys don't need to be encrypted again by calling Encrypt.

If you want to encrypt data locally in your application, you can use the GenerateDataKey function to return a plaintext data encryption key and a copy of the key encrypted under the customer master key (CMK) of your choosing.

- (AWSTask<AWSKMSEncryptResponse*> *)encrypt:(AWSKMSEncryptRequest *)request

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 of AWSKMSEncryptResponse. On failed execution, task.error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorNotFound, AWSKMSErrorDisabled, AWSKMSErrorKeyUnavailable, AWSKMSErrorDependencyTimeout, AWSKMSErrorInvalidKeyUsage, AWSKMSErrorInvalidGrantToken, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidState.

Declared In

AWSKMSService.h

– encrypt:completionHandler:

Encrypts plaintext into ciphertext by using a customer master key. The Encrypt function has two primary use cases:

  • You can encrypt up to 4 KB of arbitrary data such as an RSA key, a database password, or other sensitive customer information.

  • If you are moving encrypted data from one region to another, you can use this API to encrypt in the new region the plaintext data key that was used to encrypt the data in the original region. This provides you with an encrypted copy of the data key that can be decrypted in the new region and used there to decrypt the encrypted data.

Unless you are moving encrypted data from one region to another, you don't use this function to encrypt a generated data key within a region. You retrieve data keys already encrypted by calling the GenerateDataKey or GenerateDataKeyWithoutPlaintext function. Data keys don't need to be encrypted again by calling Encrypt.

If you want to encrypt data locally in your application, you can use the GenerateDataKey function to return a plaintext data encryption key and a copy of the key encrypted under the customer master key (CMK) of your choosing.

- (void)encrypt:(AWSKMSEncryptRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSKMSEncryptResponse *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorNotFound, AWSKMSErrorDisabled, AWSKMSErrorKeyUnavailable, AWSKMSErrorDependencyTimeout, AWSKMSErrorInvalidKeyUsage, AWSKMSErrorInvalidGrantToken, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidState.

Declared In

AWSKMSService.h

– generateDataKey:

Returns a data encryption key that you can use in your application to encrypt data locally.

You must specify the customer master key (CMK) under which to generate the data key. You must also specify the length of the data key using either the KeySpec or NumberOfBytes field. You must specify one field or the other, but not both. For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use KeySpec.

This operation returns a plaintext copy of the data key in the Plaintext field of the response, and an encrypted copy of the data key in the CiphertextBlob field. The data key is encrypted under the CMK specified in the KeyId field of the request.

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

  1. Use this operation (GenerateDataKey) to retrieve a data encryption key.

  2. Use the plaintext data encryption key (returned in the Plaintext field of the response) to encrypt data locally, then erase the plaintext data key from memory.

  3. Store the encrypted data key (returned in the CiphertextBlob field of the response) alongside the locally encrypted data.

To decrypt data locally:

  1. Use the Decrypt operation to decrypt the encrypted data key into a plaintext copy of the data key.

  2. Use the plaintext data key to decrypt data locally, then erase the plaintext data key from memory.

To return only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To return an arbitrary unpredictable byte string, use GenerateRandom.

If you use the optional EncryptionContext field, you must store at least enough information to be able to reconstruct the full encryption context when you later send the ciphertext to the Decrypt operation. It is a good practice to choose an encryption context that you can reconstruct on the fly to better secure the ciphertext. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

- (AWSTask<AWSKMSGenerateDataKeyResponse*> *)generateDataKey:(AWSKMSGenerateDataKeyRequest *)request

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 of AWSKMSGenerateDataKeyResponse. On failed execution, task.error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorNotFound, AWSKMSErrorDisabled, AWSKMSErrorKeyUnavailable, AWSKMSErrorDependencyTimeout, AWSKMSErrorInvalidKeyUsage, AWSKMSErrorInvalidGrantToken, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidState.

Declared In

AWSKMSService.h

– generateDataKey:completionHandler:

Returns a data encryption key that you can use in your application to encrypt data locally.

You must specify the customer master key (CMK) under which to generate the data key. You must also specify the length of the data key using either the KeySpec or NumberOfBytes field. You must specify one field or the other, but not both. For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use KeySpec.

This operation returns a plaintext copy of the data key in the Plaintext field of the response, and an encrypted copy of the data key in the CiphertextBlob field. The data key is encrypted under the CMK specified in the KeyId field of the request.

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

  1. Use this operation (GenerateDataKey) to retrieve a data encryption key.

  2. Use the plaintext data encryption key (returned in the Plaintext field of the response) to encrypt data locally, then erase the plaintext data key from memory.

  3. Store the encrypted data key (returned in the CiphertextBlob field of the response) alongside the locally encrypted data.

To decrypt data locally:

  1. Use the Decrypt operation to decrypt the encrypted data key into a plaintext copy of the data key.

  2. Use the plaintext data key to decrypt data locally, then erase the plaintext data key from memory.

To return only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To return an arbitrary unpredictable byte string, use GenerateRandom.

If you use the optional EncryptionContext field, you must store at least enough information to be able to reconstruct the full encryption context when you later send the ciphertext to the Decrypt operation. It is a good practice to choose an encryption context that you can reconstruct on the fly to better secure the ciphertext. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

- (void)generateDataKey:(AWSKMSGenerateDataKeyRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSKMSGenerateDataKeyResponse *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorNotFound, AWSKMSErrorDisabled, AWSKMSErrorKeyUnavailable, AWSKMSErrorDependencyTimeout, AWSKMSErrorInvalidKeyUsage, AWSKMSErrorInvalidGrantToken, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidState.

Declared In

AWSKMSService.h

– generateDataKeyWithoutPlaintext:

Returns a data encryption key encrypted under a customer master key (CMK). This operation is identical to GenerateDataKey but returns only the encrypted copy of the data key.

This operation is useful in a system that has multiple components with different degrees of trust. For example, consider a system that stores encrypted data in containers. Each container stores the encrypted data and an encrypted copy of the data key. One component of the system, called the control plane, creates new containers. When it creates a new container, it uses this operation (GenerateDataKeyWithoutPlaintext) to get an encrypted data key and then stores it in the container. Later, a different component of the system, called the data plane, puts encrypted data into the containers. To do this, it passes the encrypted data key to the Decrypt operation, then uses the returned plaintext data key to encrypt data, and finally stores the encrypted data in the container. In this system, the control plane never sees the plaintext data key.

- (AWSTask<AWSKMSGenerateDataKeyWithoutPlaintextResponse*> *)generateDataKeyWithoutPlaintext:(AWSKMSGenerateDataKeyWithoutPlaintextRequest *)request

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 of AWSKMSGenerateDataKeyWithoutPlaintextResponse. On failed execution, task.error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorNotFound, AWSKMSErrorDisabled, AWSKMSErrorKeyUnavailable, AWSKMSErrorDependencyTimeout, AWSKMSErrorInvalidKeyUsage, AWSKMSErrorInvalidGrantToken, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidState.

Declared In

AWSKMSService.h

– generateDataKeyWithoutPlaintext:completionHandler:

Returns a data encryption key encrypted under a customer master key (CMK). This operation is identical to GenerateDataKey but returns only the encrypted copy of the data key.

This operation is useful in a system that has multiple components with different degrees of trust. For example, consider a system that stores encrypted data in containers. Each container stores the encrypted data and an encrypted copy of the data key. One component of the system, called the control plane, creates new containers. When it creates a new container, it uses this operation (GenerateDataKeyWithoutPlaintext) to get an encrypted data key and then stores it in the container. Later, a different component of the system, called the data plane, puts encrypted data into the containers. To do this, it passes the encrypted data key to the Decrypt operation, then uses the returned plaintext data key to encrypt data, and finally stores the encrypted data in the container. In this system, the control plane never sees the plaintext data key.

- (void)generateDataKeyWithoutPlaintext:(AWSKMSGenerateDataKeyWithoutPlaintextRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSKMSGenerateDataKeyWithoutPlaintextResponse *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorNotFound, AWSKMSErrorDisabled, AWSKMSErrorKeyUnavailable, AWSKMSErrorDependencyTimeout, AWSKMSErrorInvalidKeyUsage, AWSKMSErrorInvalidGrantToken, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidState.

Declared In

AWSKMSService.h

– generateRandom:

Generates an unpredictable byte string.

- (AWSTask<AWSKMSGenerateRandomResponse*> *)generateRandom:(AWSKMSGenerateRandomRequest *)request

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 of AWSKMSGenerateRandomResponse. On failed execution, task.error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorDependencyTimeout, AWSKMSErrorKMSInternal.

Declared In

AWSKMSService.h

– generateRandom:completionHandler:

Generates an unpredictable byte string.

- (void)generateRandom:(AWSKMSGenerateRandomRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSKMSGenerateRandomResponse *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorDependencyTimeout, AWSKMSErrorKMSInternal.

Declared In

AWSKMSService.h

– getKeyPolicy:

Retrieves a policy attached to the specified key.

- (AWSTask<AWSKMSGetKeyPolicyResponse*> *)getKeyPolicy:(AWSKMSGetKeyPolicyRequest *)request

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 of AWSKMSGetKeyPolicyResponse. On failed execution, task.error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorNotFound, AWSKMSErrorInvalidArn, AWSKMSErrorDependencyTimeout, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidState.

Declared In

AWSKMSService.h

– getKeyPolicy:completionHandler:

Retrieves a policy attached to the specified key.

- (void)getKeyPolicy:(AWSKMSGetKeyPolicyRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSKMSGetKeyPolicyResponse *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorNotFound, AWSKMSErrorInvalidArn, AWSKMSErrorDependencyTimeout, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidState.

Declared In

AWSKMSService.h

– getKeyRotationStatus:

Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key.

- (AWSTask<AWSKMSGetKeyRotationStatusResponse*> *)getKeyRotationStatus:(AWSKMSGetKeyRotationStatusRequest *)request

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 of AWSKMSGetKeyRotationStatusResponse. On failed execution, task.error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorNotFound, AWSKMSErrorInvalidArn, AWSKMSErrorDependencyTimeout, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidState, AWSKMSErrorUnsupportedOperation.

Declared In

AWSKMSService.h

– getKeyRotationStatus:completionHandler:

Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key.

- (void)getKeyRotationStatus:(AWSKMSGetKeyRotationStatusRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSKMSGetKeyRotationStatusResponse *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorNotFound, AWSKMSErrorInvalidArn, AWSKMSErrorDependencyTimeout, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidState, AWSKMSErrorUnsupportedOperation.

Declared In

AWSKMSService.h

– getParametersForImport:

Returns the items you need in order to import key material into AWS KMS from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.

You must specify the key ID of the customer master key (CMK) into which you will import key material. This CMK's Origin must be EXTERNAL. You must also specify the wrapping algorithm and type of wrapping key (public key) that you will use to encrypt the key material.

This operation returns a public key and an import token. Use the public key to encrypt the key material. Store the import token to send with a subsequent ImportKeyMaterial request. The public key and import token from the same response must be used together. These items are valid for 24 hours, after which they cannot be used for a subsequent ImportKeyMaterial request. To retrieve new ones, send another GetParametersForImport request.

- (AWSTask<AWSKMSGetParametersForImportResponse*> *)getParametersForImport:(AWSKMSGetParametersForImportRequest *)request

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 of AWSKMSGetParametersForImportResponse. On failed execution, task.error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorInvalidArn, AWSKMSErrorUnsupportedOperation, AWSKMSErrorDependencyTimeout, AWSKMSErrorNotFound, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidState.

Declared In

AWSKMSService.h

– getParametersForImport:completionHandler:

Returns the items you need in order to import key material into AWS KMS from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.

You must specify the key ID of the customer master key (CMK) into which you will import key material. This CMK's Origin must be EXTERNAL. You must also specify the wrapping algorithm and type of wrapping key (public key) that you will use to encrypt the key material.

This operation returns a public key and an import token. Use the public key to encrypt the key material. Store the import token to send with a subsequent ImportKeyMaterial request. The public key and import token from the same response must be used together. These items are valid for 24 hours, after which they cannot be used for a subsequent ImportKeyMaterial request. To retrieve new ones, send another GetParametersForImport request.

- (void)getParametersForImport:(AWSKMSGetParametersForImportRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSKMSGetParametersForImportResponse *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorInvalidArn, AWSKMSErrorUnsupportedOperation, AWSKMSErrorDependencyTimeout, AWSKMSErrorNotFound, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidState.

Declared In

AWSKMSService.h

– importKeyMaterial:

Imports key material into an AWS KMS customer master key (CMK) from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.

You must specify the key ID of the CMK to import the key material into. This CMK's Origin must be EXTERNAL. You must also send an import token and the encrypted key material. Send the import token that you received in the same GetParametersForImport response that contained the public key that you used to encrypt the key material. You must also specify whether the key material expires and if so, when. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. To use the CMK again, you can reimport the same key material. If you set an expiration date, you can change it only by reimporting the same key material and specifying a new expiration date.

When this operation is successful, the specified CMK's key state changes to Enabled, and you can use the CMK.

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.

- (AWSTask<AWSKMSImportKeyMaterialResponse*> *)importKeyMaterial:(AWSKMSImportKeyMaterialRequest *)request

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 of AWSKMSImportKeyMaterialResponse. On failed execution, task.error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorInvalidArn, AWSKMSErrorUnsupportedOperation, AWSKMSErrorDependencyTimeout, AWSKMSErrorNotFound, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidState, AWSKMSErrorInvalidCiphertext, AWSKMSErrorIncorrectKeyMaterial, AWSKMSErrorExpiredImportToken, AWSKMSErrorInvalidImportToken.

Declared In

AWSKMSService.h

– importKeyMaterial:completionHandler:

Imports key material into an AWS KMS customer master key (CMK) from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.

You must specify the key ID of the CMK to import the key material into. This CMK's Origin must be EXTERNAL. You must also send an import token and the encrypted key material. Send the import token that you received in the same GetParametersForImport response that contained the public key that you used to encrypt the key material. You must also specify whether the key material expires and if so, when. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. To use the CMK again, you can reimport the same key material. If you set an expiration date, you can change it only by reimporting the same key material and specifying a new expiration date.

When this operation is successful, the specified CMK's key state changes to Enabled, and you can use the CMK.

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.

- (void)importKeyMaterial:(AWSKMSImportKeyMaterialRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSKMSImportKeyMaterialResponse *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorInvalidArn, AWSKMSErrorUnsupportedOperation, AWSKMSErrorDependencyTimeout, AWSKMSErrorNotFound, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidState, AWSKMSErrorInvalidCiphertext, AWSKMSErrorIncorrectKeyMaterial, AWSKMSErrorExpiredImportToken, AWSKMSErrorInvalidImportToken.

Declared In

AWSKMSService.h

– listAliases:

Lists all of the key aliases in the account.

- (AWSTask<AWSKMSListAliasesResponse*> *)listAliases:(AWSKMSListAliasesRequest *)request

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 of AWSKMSListAliasesResponse. On failed execution, task.error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorDependencyTimeout, AWSKMSErrorInvalidMarker, AWSKMSErrorKMSInternal.

Declared In

AWSKMSService.h

– listAliases:completionHandler:

Lists all of the key aliases in the account.

- (void)listAliases:(AWSKMSListAliasesRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSKMSListAliasesResponse *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorDependencyTimeout, AWSKMSErrorInvalidMarker, AWSKMSErrorKMSInternal.

Declared In

AWSKMSService.h

– listGrants:

List the grants for a specified key.

- (AWSTask<AWSKMSListGrantsResponse*> *)listGrants:(AWSKMSListGrantsRequest *)request

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 of AWSKMSListGrantsResponse. On failed execution, task.error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorNotFound, AWSKMSErrorDependencyTimeout, AWSKMSErrorInvalidMarker, AWSKMSErrorInvalidArn, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidState.

Declared In

AWSKMSService.h

– listGrants:completionHandler:

List the grants for a specified key.

- (void)listGrants:(AWSKMSListGrantsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSKMSListGrantsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorNotFound, AWSKMSErrorDependencyTimeout, AWSKMSErrorInvalidMarker, AWSKMSErrorInvalidArn, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidState.

Declared In

AWSKMSService.h

– listKeyPolicies:

Retrieves a list of policies attached to a key.

- (AWSTask<AWSKMSListKeyPoliciesResponse*> *)listKeyPolicies:(AWSKMSListKeyPoliciesRequest *)request

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 of AWSKMSListKeyPoliciesResponse. On failed execution, task.error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorNotFound, AWSKMSErrorInvalidArn, AWSKMSErrorDependencyTimeout, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidState.

Declared In

AWSKMSService.h

– listKeyPolicies:completionHandler:

Retrieves a list of policies attached to a key.

- (void)listKeyPolicies:(AWSKMSListKeyPoliciesRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSKMSListKeyPoliciesResponse *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorNotFound, AWSKMSErrorInvalidArn, AWSKMSErrorDependencyTimeout, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidState.

Declared In

AWSKMSService.h

– listKeys:

Lists the customer master keys.

- (AWSTask<AWSKMSListKeysResponse*> *)listKeys:(AWSKMSListKeysRequest *)request

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 of AWSKMSListKeysResponse. On failed execution, task.error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorDependencyTimeout, AWSKMSErrorKMSInternal, AWSKMSErrorInvalidMarker.

Declared In

AWSKMSService.h

– listKeys:completionHandler:

Lists the customer master keys.

- (void)listKeys:(AWSKMSListKeysRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSKMSListKeysResponse *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorDependencyTimeout, AWSKMSErrorKMSInternal, AWSKMSErrorInvalidMarker.

Declared In

AWSKMSService.h

– listResourceTags:

Returns a list of all tags for the specified customer master key (CMK).

- (AWSTask<AWSKMSListResourceTagsResponse*> *)listResourceTags:(AWSKMSListResourceTagsRequest *)request

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 of AWSKMSListResourceTagsResponse. On failed execution, task.error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorKMSInternal, AWSKMSErrorNotFound, AWSKMSErrorInvalidArn, AWSKMSErrorInvalidMarker.

Declared In

AWSKMSService.h

– listResourceTags:completionHandler:

Returns a list of all tags for the specified customer master key (CMK).

- (void)listResourceTags:(AWSKMSListResourceTagsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSKMSListResourceTagsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorKMSInternal, AWSKMSErrorNotFound, AWSKMSErrorInvalidArn, AWSKMSErrorInvalidMarker.

Declared In

AWSKMSService.h

– listRetirableGrants:

Returns a list of all grants for which the grant's RetiringPrincipal matches the one specified.

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

- (AWSTask<AWSKMSListGrantsResponse*> *)listRetirableGrants:(AWSKMSListRetirableGrantsRequest *)request

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 of AWSKMSListGrantsResponse. On failed execution, task.error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorDependencyTimeout, AWSKMSErrorInvalidMarker, AWSKMSErrorInvalidArn, AWSKMSErrorNotFound, AWSKMSErrorKMSInternal.

Declared In

AWSKMSService.h

– listRetirableGrants:completionHandler:

Returns a list of all grants for which the grant's RetiringPrincipal matches the one specified.

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

- (void)listRetirableGrants:(AWSKMSListRetirableGrantsRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSKMSListGrantsResponse *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorDependencyTimeout, AWSKMSErrorInvalidMarker, AWSKMSErrorInvalidArn, AWSKMSErrorNotFound, AWSKMSErrorKMSInternal.

Declared In

AWSKMSService.h

– putKeyPolicy:

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.

- (AWSTask *)putKeyPolicy:(AWSKMSPutKeyPolicyRequest *)request

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 be nil. On failed execution, task.error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorNotFound, AWSKMSErrorInvalidArn, AWSKMSErrorMalformedPolicyDocument, AWSKMSErrorDependencyTimeout, AWSKMSErrorUnsupportedOperation, AWSKMSErrorKMSInternal, AWSKMSErrorLimitExceeded, AWSKMSErrorKMSInvalidState.

Declared In

AWSKMSService.h

– putKeyPolicy:completionHandler:

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.

- (void)putKeyPolicy:(AWSKMSPutKeyPolicyRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorNotFound, AWSKMSErrorInvalidArn, AWSKMSErrorMalformedPolicyDocument, AWSKMSErrorDependencyTimeout, AWSKMSErrorUnsupportedOperation, AWSKMSErrorKMSInternal, AWSKMSErrorLimitExceeded, AWSKMSErrorKMSInvalidState.

Declared In

AWSKMSService.h

– reEncrypt:

Encrypts data on the server side with a new customer master key (CMK) without exposing the plaintext of the data on the client side. The data is first decrypted and then reencrypted. You can also use this operation to change the encryption context of a ciphertext.

Unlike other operations, ReEncrypt is authorized twice, once as ReEncryptFrom on the source CMK and once as ReEncryptTo on the destination CMK. We recommend that you include the "kms:ReEncrypt*" permission in your key policies to permit reencryption from or to the CMK. This permission is automatically included in the key policy when you create a CMK through the console, but you must include it manually when you create a CMK programmatically or when you set a key policy with the PutKeyPolicy operation.

- (AWSTask<AWSKMSReEncryptResponse*> *)reEncrypt:(AWSKMSReEncryptRequest *)request

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 of AWSKMSReEncryptResponse. On failed execution, task.error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorNotFound, AWSKMSErrorDisabled, AWSKMSErrorInvalidCiphertext, AWSKMSErrorKeyUnavailable, AWSKMSErrorDependencyTimeout, AWSKMSErrorInvalidKeyUsage, AWSKMSErrorInvalidGrantToken, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidState.

Declared In

AWSKMSService.h

– reEncrypt:completionHandler:

Encrypts data on the server side with a new customer master key (CMK) without exposing the plaintext of the data on the client side. The data is first decrypted and then reencrypted. You can also use this operation to change the encryption context of a ciphertext.

Unlike other operations, ReEncrypt is authorized twice, once as ReEncryptFrom on the source CMK and once as ReEncryptTo on the destination CMK. We recommend that you include the "kms:ReEncrypt*" permission in your key policies to permit reencryption from or to the CMK. This permission is automatically included in the key policy when you create a CMK through the console, but you must include it manually when you create a CMK programmatically or when you set a key policy with the PutKeyPolicy operation.

- (void)reEncrypt:(AWSKMSReEncryptRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSKMSReEncryptResponse *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorNotFound, AWSKMSErrorDisabled, AWSKMSErrorInvalidCiphertext, AWSKMSErrorKeyUnavailable, AWSKMSErrorDependencyTimeout, AWSKMSErrorInvalidKeyUsage, AWSKMSErrorInvalidGrantToken, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidState.

Declared In

AWSKMSService.h

– retireGrant:

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

  • The AWS account (root user) under which the grant was created

  • The RetiringPrincipal, if present in the grant

  • The GranteePrincipal, if RetireGrant is an operation specified in the grant

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

- (AWSTask *)retireGrant:(AWSKMSRetireGrantRequest *)request

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 be nil. On failed execution, task.error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorInvalidGrantToken, AWSKMSErrorInvalidGrantId, AWSKMSErrorNotFound, AWSKMSErrorDependencyTimeout, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidState.

Declared In

AWSKMSService.h

– retireGrant:completionHandler:

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

  • The AWS account (root user) under which the grant was created

  • The RetiringPrincipal, if present in the grant

  • The GranteePrincipal, if RetireGrant is an operation specified in the grant

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

- (void)retireGrant:(AWSKMSRetireGrantRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorInvalidGrantToken, AWSKMSErrorInvalidGrantId, AWSKMSErrorNotFound, AWSKMSErrorDependencyTimeout, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidState.

Declared In

AWSKMSService.h

– revokeGrant:

Revokes a grant. You can revoke a grant to actively deny operations that depend on it.

- (AWSTask *)revokeGrant:(AWSKMSRevokeGrantRequest *)request

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 be nil. On failed execution, task.error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorNotFound, AWSKMSErrorDependencyTimeout, AWSKMSErrorInvalidArn, AWSKMSErrorInvalidGrantId, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidState.

Declared In

AWSKMSService.h

– revokeGrant:completionHandler:

Revokes a grant. You can revoke a grant to actively deny operations that depend on it.

- (void)revokeGrant:(AWSKMSRevokeGrantRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorNotFound, AWSKMSErrorDependencyTimeout, AWSKMSErrorInvalidArn, AWSKMSErrorInvalidGrantId, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidState.

Declared In

AWSKMSService.h

– scheduleKeyDeletion:

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 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 rendered unrecoverable. To restrict the use of a CMK without deleting it, use DisableKey.

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

- (AWSTask<AWSKMSScheduleKeyDeletionResponse*> *)scheduleKeyDeletion:(AWSKMSScheduleKeyDeletionRequest *)request

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 of AWSKMSScheduleKeyDeletionResponse. On failed execution, task.error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorNotFound, AWSKMSErrorInvalidArn, AWSKMSErrorDependencyTimeout, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidState.

Declared In

AWSKMSService.h

– scheduleKeyDeletion:completionHandler:

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 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 rendered unrecoverable. To restrict the use of a CMK without deleting it, use DisableKey.

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

- (void)scheduleKeyDeletion:(AWSKMSScheduleKeyDeletionRequest *)request completionHandler:(void ( ^ _Nullable ) ( AWSKMSScheduleKeyDeletionResponse *_Nullable response , NSError *_Nullable error ))completionHandler

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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorNotFound, AWSKMSErrorInvalidArn, AWSKMSErrorDependencyTimeout, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidState.

Declared In

AWSKMSService.h

– tagResource:

Adds or overwrites one or more tags for the specified customer master key (CMK).

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

You cannot use the same tag key more than once per CMK. For example, consider a CMK with one tag whose tag key is Purpose and tag value is Test. If you send a TagResource request for this CMK with a tag key of Purpose and a tag value of Prod, it does not create a second tag. Instead, the original tag is overwritten with the new tag value.

- (AWSTask *)tagResource:(AWSKMSTagResourceRequest *)request

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 be nil. On failed execution, task.error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorKMSInternal, AWSKMSErrorNotFound, AWSKMSErrorInvalidArn, AWSKMSErrorKMSInvalidState, AWSKMSErrorLimitExceeded, AWSKMSErrorTag.

Declared In

AWSKMSService.h

– tagResource:completionHandler:

Adds or overwrites one or more tags for the specified customer master key (CMK).

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

You cannot use the same tag key more than once per CMK. For example, consider a CMK with one tag whose tag key is Purpose and tag value is Test. If you send a TagResource request for this CMK with a tag key of Purpose and a tag value of Prod, it does not create a second tag. Instead, the original tag is overwritten with the new tag value.

- (void)tagResource:(AWSKMSTagResourceRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorKMSInternal, AWSKMSErrorNotFound, AWSKMSErrorInvalidArn, AWSKMSErrorKMSInvalidState, AWSKMSErrorLimitExceeded, AWSKMSErrorTag.

Declared In

AWSKMSService.h

– untagResource:

Removes the specified tag or tags from the specified customer master key (CMK).

To remove a tag, you specify the tag key for each tag to remove. You do not specify the tag value. To overwrite the tag value for an existing tag, use TagResource.

- (AWSTask *)untagResource:(AWSKMSUntagResourceRequest *)request

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 be nil. On failed execution, task.error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorKMSInternal, AWSKMSErrorNotFound, AWSKMSErrorInvalidArn, AWSKMSErrorKMSInvalidState, AWSKMSErrorTag.

Declared In

AWSKMSService.h

– untagResource:completionHandler:

Removes the specified tag or tags from the specified customer master key (CMK).

To remove a tag, you specify the tag key for each tag to remove. You do not specify the tag value. To overwrite the tag value for an existing tag, use TagResource.

- (void)untagResource:(AWSKMSUntagResourceRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorKMSInternal, AWSKMSErrorNotFound, AWSKMSErrorInvalidArn, AWSKMSErrorKMSInvalidState, AWSKMSErrorTag.

Declared In

AWSKMSService.h

– updateAlias:

Updates an alias to map it to a different key.

An alias is not a property of a key. Therefore, an alias can be mapped to and unmapped from an existing key without changing the properties of the key.

An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word "alias" followed by a forward slash (alias/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS).

The alias and the key it is mapped to must be in the same AWS account and the same region.

- (AWSTask *)updateAlias:(AWSKMSUpdateAliasRequest *)request

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 be nil. On failed execution, task.error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorDependencyTimeout, AWSKMSErrorNotFound, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidState.

Declared In

AWSKMSService.h

– updateAlias:completionHandler:

Updates an alias to map it to a different key.

An alias is not a property of a key. Therefore, an alias can be mapped to and unmapped from an existing key without changing the properties of the key.

An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word "alias" followed by a forward slash (alias/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS).

The alias and the key it is mapped to must be in the same AWS account and the same region.

- (void)updateAlias:(AWSKMSUpdateAliasRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorDependencyTimeout, AWSKMSErrorNotFound, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidState.

Declared In

AWSKMSService.h

– updateKeyDescription:

Updates the description of a customer master key (CMK).

- (AWSTask *)updateKeyDescription:(AWSKMSUpdateKeyDescriptionRequest *)request

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 be nil. On failed execution, task.error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorNotFound, AWSKMSErrorInvalidArn, AWSKMSErrorDependencyTimeout, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidState.

Declared In

AWSKMSService.h

– updateKeyDescription:completionHandler:

Updates the description of a customer master key (CMK).

- (void)updateKeyDescription:(AWSKMSUpdateKeyDescriptionRequest *)request completionHandler:(void ( ^ _Nullable ) ( NSError *_Nullable error ))completionHandler

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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSKMSErrorDomain domain and the following error code: AWSKMSErrorNotFound, AWSKMSErrorInvalidArn, AWSKMSErrorDependencyTimeout, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidState.

Declared In

AWSKMSService.h