// // Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. // // Licensed under the Apache License, Version 2.0 (the "License"). // You may not use this file except in compliance with the License. // A copy of the License is located at // // http://aws.amazon.com/apache2.0 // // or in the "license" file accompanying this file. This file is distributed // on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either // express or implied. See the License for the specific language governing // permissions and limitations under the License. // #import #import #import NS_ASSUME_NONNULL_BEGIN FOUNDATION_EXPORT NSString *const AWSKMSErrorDomain; typedef NS_ENUM(NSInteger, AWSKMSErrorType) { AWSKMSErrorUnknown, AWSKMSErrorAlreadyExists, AWSKMSErrorCloudHsmClusterInUse, AWSKMSErrorCloudHsmClusterInvalidConfiguration, AWSKMSErrorCloudHsmClusterNotActive, AWSKMSErrorCloudHsmClusterNotFound, AWSKMSErrorCloudHsmClusterNotRelated, AWSKMSErrorCustomKeyStoreHasCMKs, AWSKMSErrorCustomKeyStoreInvalidState, AWSKMSErrorCustomKeyStoreNameInUse, AWSKMSErrorCustomKeyStoreNotFound, AWSKMSErrorDependencyTimeout, AWSKMSErrorDisabled, AWSKMSErrorDryRunOperation, AWSKMSErrorExpiredImportToken, AWSKMSErrorIncorrectKey, AWSKMSErrorIncorrectKeyMaterial, AWSKMSErrorIncorrectTrustAnchor, AWSKMSErrorInvalidAliasName, AWSKMSErrorInvalidArn, AWSKMSErrorInvalidCiphertext, AWSKMSErrorInvalidGrantId, AWSKMSErrorInvalidGrantToken, AWSKMSErrorInvalidImportToken, AWSKMSErrorInvalidKeyUsage, AWSKMSErrorInvalidMarker, AWSKMSErrorKMSInternal, AWSKMSErrorKMSInvalidMac, AWSKMSErrorKMSInvalidSignature, AWSKMSErrorKMSInvalidState, AWSKMSErrorKeyUnavailable, AWSKMSErrorLimitExceeded, AWSKMSErrorMalformedPolicyDocument, AWSKMSErrorNotFound, AWSKMSErrorTag, AWSKMSErrorUnsupportedOperation, AWSKMSErrorXksKeyAlreadyInUse, AWSKMSErrorXksKeyInvalidConfiguration, AWSKMSErrorXksKeyNotFound, AWSKMSErrorXksProxyIncorrectAuthenticationCredential, AWSKMSErrorXksProxyInvalidConfiguration, AWSKMSErrorXksProxyInvalidResponse, AWSKMSErrorXksProxyUriEndpointInUse, AWSKMSErrorXksProxyUriInUse, AWSKMSErrorXksProxyUriUnreachable, AWSKMSErrorXksProxyVpcEndpointServiceInUse, AWSKMSErrorXksProxyVpcEndpointServiceInvalidConfiguration, AWSKMSErrorXksProxyVpcEndpointServiceNotFound, }; typedef NS_ENUM(NSInteger, AWSKMSAlgorithmSpec) { AWSKMSAlgorithmSpecUnknown, AWSKMSAlgorithmSpecRsaesPkcs1V15, AWSKMSAlgorithmSpecRsaesOaepSha1, AWSKMSAlgorithmSpecRsaesOaepSha256, AWSKMSAlgorithmSpecRsaAesKeyWrapSha1, AWSKMSAlgorithmSpecRsaAesKeyWrapSha256, }; typedef NS_ENUM(NSInteger, AWSKMSConnectionErrorCodeType) { AWSKMSConnectionErrorCodeTypeUnknown, AWSKMSConnectionErrorCodeTypeInvalidCredentials, AWSKMSConnectionErrorCodeTypeClusterNotFound, AWSKMSConnectionErrorCodeTypeNetworkErrors, AWSKMSConnectionErrorCodeTypeInternalError, AWSKMSConnectionErrorCodeTypeInsufficientCloudhsmHsms, AWSKMSConnectionErrorCodeTypeUserLockedOut, AWSKMSConnectionErrorCodeTypeUserNotFound, AWSKMSConnectionErrorCodeTypeUserLoggedIn, AWSKMSConnectionErrorCodeTypeSubnetNotFound, AWSKMSConnectionErrorCodeTypeInsufficientFreeAddressesInSubnet, AWSKMSConnectionErrorCodeTypeXksProxyAccessDenied, AWSKMSConnectionErrorCodeTypeXksProxyNotReachable, AWSKMSConnectionErrorCodeTypeXksVpcEndpointServiceNotFound, AWSKMSConnectionErrorCodeTypeXksProxyInvalidResponse, AWSKMSConnectionErrorCodeTypeXksProxyInvalidConfiguration, AWSKMSConnectionErrorCodeTypeXksVpcEndpointServiceInvalidConfiguration, AWSKMSConnectionErrorCodeTypeXksProxyTimedOut, AWSKMSConnectionErrorCodeTypeXksProxyInvalidTlsConfiguration, }; typedef NS_ENUM(NSInteger, AWSKMSConnectionStateType) { AWSKMSConnectionStateTypeUnknown, AWSKMSConnectionStateTypeConnected, AWSKMSConnectionStateTypeConnecting, AWSKMSConnectionStateTypeFailed, AWSKMSConnectionStateTypeDisconnected, AWSKMSConnectionStateTypeDisconnecting, }; typedef NS_ENUM(NSInteger, AWSKMSCustomKeyStoreType) { AWSKMSCustomKeyStoreTypeUnknown, AWSKMSCustomKeyStoreTypeAwsCloudhsm, AWSKMSCustomKeyStoreTypeExternalKeyStore, }; typedef NS_ENUM(NSInteger, AWSKMSCustomerMasterKeySpec) { AWSKMSCustomerMasterKeySpecUnknown, AWSKMSCustomerMasterKeySpecRsa2048, AWSKMSCustomerMasterKeySpecRsa3072, AWSKMSCustomerMasterKeySpecRsa4096, AWSKMSCustomerMasterKeySpecEccNistP256, AWSKMSCustomerMasterKeySpecEccNistP384, AWSKMSCustomerMasterKeySpecEccNistP521, AWSKMSCustomerMasterKeySpecEccSecgP256k1, AWSKMSCustomerMasterKeySpecSymmetricDefault, AWSKMSCustomerMasterKeySpecHmac224, AWSKMSCustomerMasterKeySpecHmac256, AWSKMSCustomerMasterKeySpecHmac384, AWSKMSCustomerMasterKeySpecHmac512, AWSKMSCustomerMasterKeySpecSm2, }; typedef NS_ENUM(NSInteger, AWSKMSDataKeyPairSpec) { AWSKMSDataKeyPairSpecUnknown, AWSKMSDataKeyPairSpecRsa2048, AWSKMSDataKeyPairSpecRsa3072, AWSKMSDataKeyPairSpecRsa4096, AWSKMSDataKeyPairSpecEccNistP256, AWSKMSDataKeyPairSpecEccNistP384, AWSKMSDataKeyPairSpecEccNistP521, AWSKMSDataKeyPairSpecEccSecgP256k1, AWSKMSDataKeyPairSpecSm2, }; typedef NS_ENUM(NSInteger, AWSKMSDataKeySpec) { AWSKMSDataKeySpecUnknown, AWSKMSDataKeySpecAes256, AWSKMSDataKeySpecAes128, }; typedef NS_ENUM(NSInteger, AWSKMSEncryptionAlgorithmSpec) { AWSKMSEncryptionAlgorithmSpecUnknown, AWSKMSEncryptionAlgorithmSpecSymmetricDefault, AWSKMSEncryptionAlgorithmSpecRsaesOaepSha1, AWSKMSEncryptionAlgorithmSpecRsaesOaepSha256, AWSKMSEncryptionAlgorithmSpecSm2pke, }; typedef NS_ENUM(NSInteger, AWSKMSExpirationModelType) { AWSKMSExpirationModelTypeUnknown, AWSKMSExpirationModelTypeKeyMaterialExpires, AWSKMSExpirationModelTypeKeyMaterialDoesNotExpire, }; typedef NS_ENUM(NSInteger, AWSKMSGrantOperation) { AWSKMSGrantOperationUnknown, AWSKMSGrantOperationDecrypt, AWSKMSGrantOperationEncrypt, AWSKMSGrantOperationGenerateDataKey, AWSKMSGrantOperationGenerateDataKeyWithoutPlaintext, AWSKMSGrantOperationReEncryptFrom, AWSKMSGrantOperationReEncryptTo, AWSKMSGrantOperationSign, AWSKMSGrantOperationVerify, AWSKMSGrantOperationGetPublicKey, AWSKMSGrantOperationCreateGrant, AWSKMSGrantOperationRetireGrant, AWSKMSGrantOperationDescribeKey, AWSKMSGrantOperationGenerateDataKeyPair, AWSKMSGrantOperationGenerateDataKeyPairWithoutPlaintext, AWSKMSGrantOperationGenerateMac, AWSKMSGrantOperationVerifyMac, }; typedef NS_ENUM(NSInteger, AWSKMSKeyEncryptionMechanism) { AWSKMSKeyEncryptionMechanismUnknown, AWSKMSKeyEncryptionMechanismRsaesOaepSha256, }; typedef NS_ENUM(NSInteger, AWSKMSKeyManagerType) { AWSKMSKeyManagerTypeUnknown, AWSKMSKeyManagerTypeAws, AWSKMSKeyManagerTypeCustomer, }; typedef NS_ENUM(NSInteger, AWSKMSKeySpec) { AWSKMSKeySpecUnknown, AWSKMSKeySpecRsa2048, AWSKMSKeySpecRsa3072, AWSKMSKeySpecRsa4096, AWSKMSKeySpecEccNistP256, AWSKMSKeySpecEccNistP384, AWSKMSKeySpecEccNistP521, AWSKMSKeySpecEccSecgP256k1, AWSKMSKeySpecSymmetricDefault, AWSKMSKeySpecHmac224, AWSKMSKeySpecHmac256, AWSKMSKeySpecHmac384, AWSKMSKeySpecHmac512, AWSKMSKeySpecSm2, }; typedef NS_ENUM(NSInteger, AWSKMSKeyState) { AWSKMSKeyStateUnknown, AWSKMSKeyStateCreating, AWSKMSKeyStateEnabled, AWSKMSKeyStateDisabled, AWSKMSKeyStatePendingDeletion, AWSKMSKeyStatePendingImport, AWSKMSKeyStatePendingReplicaDeletion, AWSKMSKeyStateUnavailable, AWSKMSKeyStateUpdating, }; typedef NS_ENUM(NSInteger, AWSKMSKeyUsageType) { AWSKMSKeyUsageTypeUnknown, AWSKMSKeyUsageTypeSignVerify, AWSKMSKeyUsageTypeEncryptDecrypt, AWSKMSKeyUsageTypeGenerateVerifyMac, }; typedef NS_ENUM(NSInteger, AWSKMSMacAlgorithmSpec) { AWSKMSMacAlgorithmSpecUnknown, AWSKMSMacAlgorithmSpecHmacSha224, AWSKMSMacAlgorithmSpecHmacSha256, AWSKMSMacAlgorithmSpecHmacSha384, AWSKMSMacAlgorithmSpecHmacSha512, }; typedef NS_ENUM(NSInteger, AWSKMSMessageType) { AWSKMSMessageTypeUnknown, AWSKMSMessageTypeRAW, AWSKMSMessageTypeDigest, }; typedef NS_ENUM(NSInteger, AWSKMSMultiRegionKeyType) { AWSKMSMultiRegionKeyTypeUnknown, AWSKMSMultiRegionKeyTypePrimary, AWSKMSMultiRegionKeyTypeReplica, }; typedef NS_ENUM(NSInteger, AWSKMSOriginType) { AWSKMSOriginTypeUnknown, AWSKMSOriginTypeAwsKms, AWSKMSOriginTypeExternal, AWSKMSOriginTypeAwsCloudhsm, AWSKMSOriginTypeExternalKeyStore, }; typedef NS_ENUM(NSInteger, AWSKMSSigningAlgorithmSpec) { AWSKMSSigningAlgorithmSpecUnknown, AWSKMSSigningAlgorithmSpecRsassaPssSha256, AWSKMSSigningAlgorithmSpecRsassaPssSha384, AWSKMSSigningAlgorithmSpecRsassaPssSha512, AWSKMSSigningAlgorithmSpecRsassaPkcs1V15Sha256, AWSKMSSigningAlgorithmSpecRsassaPkcs1V15Sha384, AWSKMSSigningAlgorithmSpecRsassaPkcs1V15Sha512, AWSKMSSigningAlgorithmSpecEcdsaSha256, AWSKMSSigningAlgorithmSpecEcdsaSha384, AWSKMSSigningAlgorithmSpecEcdsaSha512, AWSKMSSigningAlgorithmSpecSm2dsa, }; typedef NS_ENUM(NSInteger, AWSKMSWrappingKeySpec) { AWSKMSWrappingKeySpecUnknown, AWSKMSWrappingKeySpecRsa2048, AWSKMSWrappingKeySpecRsa3072, AWSKMSWrappingKeySpecRsa4096, }; typedef NS_ENUM(NSInteger, AWSKMSXksProxyConnectivityType) { AWSKMSXksProxyConnectivityTypeUnknown, AWSKMSXksProxyConnectivityTypePublicEndpoint, AWSKMSXksProxyConnectivityTypeVpcEndpointService, }; @class AWSKMSAliasListEntry; @class AWSKMSCancelKeyDeletionRequest; @class AWSKMSCancelKeyDeletionResponse; @class AWSKMSConnectCustomKeyStoreRequest; @class AWSKMSConnectCustomKeyStoreResponse; @class AWSKMSCreateAliasRequest; @class AWSKMSCreateCustomKeyStoreRequest; @class AWSKMSCreateCustomKeyStoreResponse; @class AWSKMSCreateGrantRequest; @class AWSKMSCreateGrantResponse; @class AWSKMSCreateKeyRequest; @class AWSKMSCreateKeyResponse; @class AWSKMSCustomKeyStoresListEntry; @class AWSKMSDecryptRequest; @class AWSKMSDecryptResponse; @class AWSKMSDeleteAliasRequest; @class AWSKMSDeleteCustomKeyStoreRequest; @class AWSKMSDeleteCustomKeyStoreResponse; @class AWSKMSDeleteImportedKeyMaterialRequest; @class AWSKMSDescribeCustomKeyStoresRequest; @class AWSKMSDescribeCustomKeyStoresResponse; @class AWSKMSDescribeKeyRequest; @class AWSKMSDescribeKeyResponse; @class AWSKMSDisableKeyRequest; @class AWSKMSDisableKeyRotationRequest; @class AWSKMSDisconnectCustomKeyStoreRequest; @class AWSKMSDisconnectCustomKeyStoreResponse; @class AWSKMSEnableKeyRequest; @class AWSKMSEnableKeyRotationRequest; @class AWSKMSEncryptRequest; @class AWSKMSEncryptResponse; @class AWSKMSGenerateDataKeyPairRequest; @class AWSKMSGenerateDataKeyPairResponse; @class AWSKMSGenerateDataKeyPairWithoutPlaintextRequest; @class AWSKMSGenerateDataKeyPairWithoutPlaintextResponse; @class AWSKMSGenerateDataKeyRequest; @class AWSKMSGenerateDataKeyResponse; @class AWSKMSGenerateDataKeyWithoutPlaintextRequest; @class AWSKMSGenerateDataKeyWithoutPlaintextResponse; @class AWSKMSGenerateMacRequest; @class AWSKMSGenerateMacResponse; @class AWSKMSGenerateRandomRequest; @class AWSKMSGenerateRandomResponse; @class AWSKMSGetKeyPolicyRequest; @class AWSKMSGetKeyPolicyResponse; @class AWSKMSGetKeyRotationStatusRequest; @class AWSKMSGetKeyRotationStatusResponse; @class AWSKMSGetParametersForImportRequest; @class AWSKMSGetParametersForImportResponse; @class AWSKMSGetPublicKeyRequest; @class AWSKMSGetPublicKeyResponse; @class AWSKMSGrantConstraints; @class AWSKMSGrantListEntry; @class AWSKMSImportKeyMaterialRequest; @class AWSKMSImportKeyMaterialResponse; @class AWSKMSKeyListEntry; @class AWSKMSKeyMetadata; @class AWSKMSListAliasesRequest; @class AWSKMSListAliasesResponse; @class AWSKMSListGrantsRequest; @class AWSKMSListGrantsResponse; @class AWSKMSListKeyPoliciesRequest; @class AWSKMSListKeyPoliciesResponse; @class AWSKMSListKeysRequest; @class AWSKMSListKeysResponse; @class AWSKMSListResourceTagsRequest; @class AWSKMSListResourceTagsResponse; @class AWSKMSListRetirableGrantsRequest; @class AWSKMSMultiRegionConfiguration; @class AWSKMSMultiRegionKey; @class AWSKMSPutKeyPolicyRequest; @class AWSKMSReEncryptRequest; @class AWSKMSReEncryptResponse; @class AWSKMSRecipientInfo; @class AWSKMSReplicateKeyRequest; @class AWSKMSReplicateKeyResponse; @class AWSKMSRetireGrantRequest; @class AWSKMSRevokeGrantRequest; @class AWSKMSScheduleKeyDeletionRequest; @class AWSKMSScheduleKeyDeletionResponse; @class AWSKMSSignRequest; @class AWSKMSSignResponse; @class AWSKMSTag; @class AWSKMSTagResourceRequest; @class AWSKMSUntagResourceRequest; @class AWSKMSUpdateAliasRequest; @class AWSKMSUpdateCustomKeyStoreRequest; @class AWSKMSUpdateCustomKeyStoreResponse; @class AWSKMSUpdateKeyDescriptionRequest; @class AWSKMSUpdatePrimaryRegionRequest; @class AWSKMSVerifyMacRequest; @class AWSKMSVerifyMacResponse; @class AWSKMSVerifyRequest; @class AWSKMSVerifyResponse; @class AWSKMSXksKeyConfigurationType; @class AWSKMSXksProxyAuthenticationCredentialType; @class AWSKMSXksProxyConfigurationType; /**

Contains information about an alias.

*/ @interface AWSKMSAliasListEntry : AWSModel /**

String that contains the key ARN.

*/ @property (nonatomic, strong) NSString * _Nullable aliasArn; /**

String that contains the alias. This value begins with alias/.

*/ @property (nonatomic, strong) NSString * _Nullable aliasName; /**

Date and time that the alias was most recently created in the account and Region. Formatted as Unix time.

*/ @property (nonatomic, strong) NSDate * _Nullable creationDate; /**

Date and time that the alias was most recently associated with a KMS key in the account and Region. Formatted as Unix time.

*/ @property (nonatomic, strong) NSDate * _Nullable lastUpdatedDate; /**

String that contains the key identifier of the KMS key associated with the alias.

*/ @property (nonatomic, strong) NSString * _Nullable targetKeyId; @end /** */ @interface AWSKMSCancelKeyDeletionRequest : AWSRequest /**

Identifies the KMS key whose deletion is being canceled.

Specify the key ID or key ARN of the KMS key.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

*/ @property (nonatomic, strong) NSString * _Nullable keyId; @end /** */ @interface AWSKMSCancelKeyDeletionResponse : AWSModel /**

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

*/ @property (nonatomic, strong) NSString * _Nullable keyId; @end /** */ @interface AWSKMSConnectCustomKeyStoreRequest : AWSRequest /**

Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

*/ @property (nonatomic, strong) NSString * _Nullable customKeyStoreId; @end /** */ @interface AWSKMSConnectCustomKeyStoreResponse : AWSModel @end /** */ @interface AWSKMSCreateAliasRequest : AWSRequest /**

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

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

The AliasName value must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for Amazon Web Services managed keys.

*/ @property (nonatomic, strong) NSString * _Nullable aliasName; /**

Associates the alias with the specified customer managed key. The KMS key must be in the same Amazon Web Services Region.

A valid key ID is required. If you supply a null or empty string value, this operation returns an error.

For help finding the key ID and ARN, see Finding the Key ID and ARN in the Key Management Service Developer Guide.

Specify the key ID or key ARN of the KMS key.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

*/ @property (nonatomic, strong) NSString * _Nullable targetKeyId; @end /** */ @interface AWSKMSCreateCustomKeyStoreRequest : AWSRequest /**

Identifies the CloudHSM cluster for an CloudHSM key store. This parameter is required for custom key stores with CustomKeyStoreType of AWS_CLOUDHSM.

Enter the cluster ID of any active CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.

*/ @property (nonatomic, strong) NSString * _Nullable cloudHsmClusterId; /**

Specifies a friendly name for the custom key store. The name must be unique in your Amazon Web Services account and Region. This parameter is required for all custom key stores.

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

 */ @property (nonatomic, strong) NSString * _Nullable customKeyStoreName; /**

Specifies the type of custom key store. The default value is AWS_CLOUDHSM.

For a custom key store backed by an CloudHSM cluster, omit the parameter or enter AWS_CLOUDHSM. For a custom key store backed by an external key manager outside of Amazon Web Services, enter EXTERNAL_KEY_STORE. You cannot change this property after the key store is created.

*/ @property (nonatomic, assign) AWSKMSCustomKeyStoreType customKeyStoreType; /**

Specifies the kmsuser password for an CloudHSM key store. This parameter is required for custom key stores with a CustomKeyStoreType of AWS_CLOUDHSM.

Enter the password of the kmsuser crypto user (CU) account in the specified CloudHSM cluster. KMS logs into the cluster as this user to manage key material on your behalf.

The password must be a string of 7 to 32 characters. Its value is case sensitive.

This parameter tells KMS the kmsuser account password; it does not change the password in the CloudHSM cluster.

*/ @property (nonatomic, strong) NSString * _Nullable keyStorePassword; /**

Specifies the certificate for an CloudHSM key store. This parameter is required for custom key stores with a CustomKeyStoreType of AWS_CLOUDHSM.

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

*/ @property (nonatomic, strong) NSString * _Nullable trustAnchorCertificate; /**

Specifies an authentication credential for the external key store proxy (XKS proxy). This parameter is required for all custom key stores with a CustomKeyStoreType of EXTERNAL_KEY_STORE.

The XksProxyAuthenticationCredential has two required elements: RawSecretAccessKey, a secret key, and AccessKeyId, a unique identifier for the RawSecretAccessKey. For character requirements, see XksProxyAuthenticationCredentialType.

KMS uses this authentication credential to sign requests to the external key store proxy on your behalf. This credential is unrelated to Identity and Access Management (IAM) and Amazon Web Services credentials.

This parameter doesn't set or change the authentication credentials on the XKS proxy. It just tells KMS the credential that you established on your external key store proxy. If you rotate your proxy authentication credential, use the UpdateCustomKeyStore operation to provide the new credential to KMS.

*/ @property (nonatomic, strong) AWSKMSXksProxyAuthenticationCredentialType * _Nullable xksProxyAuthenticationCredential; /**

Indicates how KMS communicates with the external key store proxy. This parameter is required for custom key stores with a CustomKeyStoreType of EXTERNAL_KEY_STORE.

If the external key store proxy uses a public endpoint, specify PUBLIC_ENDPOINT. If the external key store proxy uses a Amazon VPC endpoint service for communication with KMS, specify VPC_ENDPOINT_SERVICE. For help making this choice, see Choosing a connectivity option in the Key Management Service Developer Guide.

An Amazon VPC endpoint service keeps your communication with KMS in a private address space entirely within Amazon Web Services, but it requires more configuration, including establishing a Amazon VPC with multiple subnets, a VPC endpoint service, a network load balancer, and a verified private DNS name. A public endpoint is simpler to set up, but it might be slower and might not fulfill your security requirements. You might consider testing with a public endpoint, and then establishing a VPC endpoint service for production tasks. Note that this choice does not determine the location of the external key store proxy. Even if you choose a VPC endpoint service, the proxy can be hosted within the VPC or outside of Amazon Web Services such as in your corporate data center.

*/ @property (nonatomic, assign) AWSKMSXksProxyConnectivityType xksProxyConnectivity; /**

Specifies the endpoint that KMS uses to send requests to the external key store proxy (XKS proxy). This parameter is required for custom key stores with a CustomKeyStoreType of EXTERNAL_KEY_STORE.

The protocol must be HTTPS. KMS communicates on port 443. Do not specify the port in the XksProxyUriEndpoint value.

For external key stores with XksProxyConnectivity value of VPC_ENDPOINT_SERVICE, specify https:// followed by the private DNS name of the VPC endpoint service.

For external key stores with PUBLIC_ENDPOINT connectivity, this endpoint must be reachable before you create the custom key store. KMS connects to the external key store proxy while creating the custom key store. For external key stores with VPC_ENDPOINT_SERVICE connectivity, KMS connects when you call the ConnectCustomKeyStore operation.

The value of this parameter must begin with https://. The remainder can contain upper and lower case letters (A-Z and a-z), numbers (0-9), dots (.), and hyphens (-). Additional slashes (/ and \) are not permitted.

Uniqueness requirements:

  • The combined XksProxyUriEndpoint and XksProxyUriPath values must be unique in the Amazon Web Services account and Region.

  • An external key store with PUBLIC_ENDPOINT connectivity cannot use the same XksProxyUriEndpoint value as an external key store with VPC_ENDPOINT_SERVICE connectivity in the same Amazon Web Services Region.

  • Each external key store with VPC_ENDPOINT_SERVICE connectivity must have its own private DNS name. The XksProxyUriEndpoint value for external key stores with VPC_ENDPOINT_SERVICE connectivity (private DNS name) must be unique in the Amazon Web Services account and Region.

*/ @property (nonatomic, strong) NSString * _Nullable xksProxyUriEndpoint; /**

Specifies the base path to the proxy APIs for this external key store. To find this value, see the documentation for your external key store proxy. This parameter is required for all custom key stores with a CustomKeyStoreType of EXTERNAL_KEY_STORE.

The value must start with / and must end with /kms/xks/v1 where v1 represents the version of the KMS external key store proxy API. This path can include an optional prefix between the required elements such as /prefix/kms/xks/v1.

Uniqueness requirements:

  • The combined XksProxyUriEndpoint and XksProxyUriPath values must be unique in the Amazon Web Services account and Region.

*/ @property (nonatomic, strong) NSString * _Nullable xksProxyUriPath; /**

Specifies the name of the Amazon VPC endpoint service for interface endpoints that is used to communicate with your external key store proxy (XKS proxy). This parameter is required when the value of CustomKeyStoreType is EXTERNAL_KEY_STORE and the value of XksProxyConnectivity is VPC_ENDPOINT_SERVICE.

The Amazon VPC endpoint service must fulfill all requirements for use with an external key store.

Uniqueness requirements:

  • External key stores with VPC_ENDPOINT_SERVICE connectivity can share an Amazon VPC, but each external key store must have its own VPC endpoint service and private DNS name.

*/ @property (nonatomic, strong) NSString * _Nullable xksProxyVpcEndpointServiceName; @end /** */ @interface AWSKMSCreateCustomKeyStoreResponse : AWSModel /**

A unique identifier for the new custom key store.

*/ @property (nonatomic, strong) NSString * _Nullable customKeyStoreId; @end /** */ @interface AWSKMSCreateGrantRequest : AWSRequest /**

Specifies a grant constraint.

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

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

The encryption context grant constraints are supported only on grant operations that include an EncryptionContext parameter, such as cryptographic operations on symmetric encryption KMS keys. Grants with grant constraints can include the DescribeKey and RetireGrant operations, but the constraint doesn't apply to these operations. If a grant with a grant constraint includes the CreateGrant operation, the constraint requires that any grants created with the CreateGrant permission have an equally strict or stricter encryption context constraint.

You cannot use an encryption context grant constraint for cryptographic operations with asymmetric KMS keys or HMAC KMS keys. Operations with these keys don't support an encryption context.

Each constraint value can include up to 8 encryption context pairs. The encryption context value in each constraint cannot exceed 384 characters. For information about grant constraints, see Using grant constraints in the Key Management Service Developer Guide. For more information about encryption context, see Encryption context in the Key Management Service Developer Guide.

*/ @property (nonatomic, strong) AWSKMSGrantConstraints * _Nullable constraints; /**

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

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

*/ @property (nonatomic, strong) NSNumber * _Nullable dryRun; /**

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

*/ @property (nonatomic, strong) NSArray * _Nullable grantTokens; /**

The identity that gets the permissions specified in the grant.

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

*/ @property (nonatomic, strong) NSString * _Nullable granteePrincipal; /**

Identifies the KMS key for the grant. The grant gives principals permission to use this KMS key.

Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

*/ @property (nonatomic, strong) NSString * _Nullable keyId; /**

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

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

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

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

*/ @property (nonatomic, strong) NSString * _Nullable name; /**

A list of operations that the grant permits.

This list must include only operations that are permitted in a grant. Also, the operation must be supported on the KMS key. For example, you cannot create a grant for a symmetric encryption KMS key that allows the Sign operation, or a grant for an asymmetric KMS key that allows the GenerateDataKey operation. If you try, KMS returns a ValidationError exception. For details, see Grant operations in the Key Management Service Developer Guide.

*/ @property (nonatomic, strong) NSArray * _Nullable operations; /**

The principal that has permission to use the RetireGrant operation to retire the grant.

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

The grant determines the retiring principal. Other principals might have permission to retire the grant or revoke the grant. For details, see RevokeGrant and Retiring and revoking grants in the Key Management Service Developer Guide.

*/ @property (nonatomic, strong) NSString * _Nullable retiringPrincipal; @end /** */ @interface AWSKMSCreateGrantResponse : AWSModel /**

The unique identifier for the grant.

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

*/ @property (nonatomic, strong) NSString * _Nullable grantId; /**

The grant token.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

*/ @property (nonatomic, strong) NSString * _Nullable grantToken; @end /** */ @interface AWSKMSCreateKeyRequest : AWSRequest /**

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

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

For more information, see Default key policy in the Key Management Service Developer Guide.

Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.

*/ @property (nonatomic, strong) NSNumber * _Nullable bypassPolicyLockoutSafetyCheck; /**

Creates the KMS key in the specified custom key store. The ConnectionState of the custom key store must be CONNECTED. To find the CustomKeyStoreID and ConnectionState use the DescribeCustomKeyStores operation.

This parameter is valid only for symmetric encryption KMS keys in a single Region. You cannot create any other type of KMS key in a custom key store.

When you create a KMS key in an CloudHSM key store, KMS generates a non-exportable 256-bit symmetric key in its associated CloudHSM cluster and associates it with the KMS key. When you create a KMS key in an external key store, you must use the XksKeyId parameter to specify an external key that serves as key material for the KMS key.

*/ @property (nonatomic, strong) NSString * _Nullable customKeyStoreId; /**

Instead, use the KeySpec parameter.

The KeySpec and CustomerMasterKeySpec parameters work the same way. Only the names differ. We recommend that you use KeySpec parameter in your code. However, to avoid breaking changes, KMS supports both parameters.

*/ @property (nonatomic, assign) AWSKMSCustomerMasterKeySpec customerMasterKeySpec; /**

A description of the KMS key. Use a description that helps you decide whether the KMS key is appropriate for a task. The default value is an empty string (no description).

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

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

*/ @property (nonatomic, strong) NSString * _Nullable detail; /**

Specifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT, creates a KMS key with a 256-bit AES-GCM key that is used for encryption and decryption, except in China Regions, where it creates a 128-bit symmetric key that uses SM4 encryption. For help choosing a key spec for your KMS key, see Choosing a KMS key type in the Key Management Service Developer Guide.

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

Amazon Web Services services that are integrated with KMS use symmetric encryption KMS keys to protect your data. These services do not support asymmetric KMS keys or HMAC KMS keys.

KMS supports the following key specs for KMS keys:

  • Symmetric encryption key (default)

    • SYMMETRIC_DEFAULT

  • HMAC keys (symmetric)

    • HMAC_224

    • HMAC_256

    • HMAC_384

    • HMAC_512

  • Asymmetric RSA key pairs

    • RSA_2048

    • RSA_3072

    • RSA_4096

  • Asymmetric NIST-recommended elliptic curve key pairs

    • ECC_NIST_P256 (secp256r1)

    • ECC_NIST_P384 (secp384r1)

    • ECC_NIST_P521 (secp521r1)

  • Other asymmetric elliptic curve key pairs

    • ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.

  • SM2 key pairs (China Regions only)

    • SM2

*/ @property (nonatomic, assign) AWSKMSKeySpec keySpec; /**

Determines the cryptographic operations for which you can use the KMS key. The default value is ENCRYPT_DECRYPT. This parameter is optional when you are creating a symmetric encryption KMS key; otherwise, it is required. You can't change the KeyUsage value after the KMS key is created.

Select only one valid value.

  • For symmetric encryption KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.

  • For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC.

  • For asymmetric KMS keys with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.

  • For asymmetric KMS keys with ECC key material, specify SIGN_VERIFY.

  • For asymmetric KMS keys with SM2 key material (China Regions only), specify ENCRYPT_DECRYPT or SIGN_VERIFY.

*/ @property (nonatomic, assign) AWSKMSKeyUsageType keyUsage; /**

Creates a multi-Region primary key that you can replicate into other Amazon Web Services Regions. You cannot change this value after you create the KMS key.

For a multi-Region key, set this parameter to True. For a single-Region KMS key, omit this parameter or set it to False. The default value is False.

This operation supports multi-Region keys, an KMS feature that lets you create multiple interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.

This value creates a primary key, not a replica. To create a replica key, use the ReplicateKey operation.

You can create a symmetric or asymmetric multi-Region key, and you can create a multi-Region key with imported key material. However, you cannot create a multi-Region key in a custom key store.

*/ @property (nonatomic, strong) NSNumber * _Nullable multiRegion; /**

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

To create a KMS key with no key material (for imported key material), set this value to EXTERNAL. For more information about importing key material into KMS, see Importing Key Material in the Key Management Service Developer Guide. The EXTERNAL origin value is valid only for symmetric KMS keys.

To create a KMS key in an CloudHSM key store and create its key material in the associated CloudHSM cluster, set this value to AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to identify the CloudHSM key store. The KeySpec value must be SYMMETRIC_DEFAULT.

To create a KMS key in an external key store, set this value to EXTERNAL_KEY_STORE. You must also use the CustomKeyStoreId parameter to identify the external key store and the XksKeyId parameter to identify the associated external key. The KeySpec value must be SYMMETRIC_DEFAULT.

*/ @property (nonatomic, assign) AWSKMSOriginType origin; /**

The key policy to attach to the KMS key.

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

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

  • Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal, you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services Identity and Access Management User Guide.

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

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

For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the Identity and Access Management User Guide.

*/ @property (nonatomic, strong) NSString * _Nullable policy; /**

Assigns one or more tags to the KMS key. Use this parameter to tag the KMS key when it is created. To tag an existing KMS key, use the TagResource operation.

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

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management Service Developer Guide.

To use this parameter, you must have kms:TagResource permission in an IAM policy.

Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.

When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details, see Tagging Keys.

*/ @property (nonatomic, strong) NSArray * _Nullable tags; /**

Identifies the external key that serves as key material for the KMS key in an external key store. Specify the ID that the external key store proxy uses to refer to the external key. For help, see the documentation for your external key store proxy.

This parameter is required for a KMS key with an Origin value of EXTERNAL_KEY_STORE. It is not valid for KMS keys with any other Origin value.

The external key must be an existing 256-bit AES symmetric encryption key hosted outside of Amazon Web Services in an external key manager associated with the external key store specified by the CustomKeyStoreId parameter. This key must be enabled and configured to perform encryption and decryption. Each KMS key in an external key store must use a different external key. For details, see Requirements for a KMS key in an external key store in the Key Management Service Developer Guide.

Each KMS key in an external key store is associated two backing keys. One is key material that KMS generates. The other is the external key specified by this parameter. When you use the KMS key in an external key store to encrypt data, the encryption operation is performed first by KMS using the KMS key material, and then by the external key manager using the specified external key, a process known as double encryption. For details, see Double encryption in the Key Management Service Developer Guide.

*/ @property (nonatomic, strong) NSString * _Nullable xksKeyId; @end /** */ @interface AWSKMSCreateKeyResponse : AWSModel /**

Metadata associated with the KMS key.

*/ @property (nonatomic, strong) AWSKMSKeyMetadata * _Nullable keyMetadata; @end /**

Contains information about each custom key store in the custom key store list.

*/ @interface AWSKMSCustomKeyStoresListEntry : AWSModel /**

A unique identifier for the CloudHSM cluster that is associated with an CloudHSM key store. This field appears only when the CustomKeyStoreType is AWS_CLOUDHSM.

*/ @property (nonatomic, strong) NSString * _Nullable cloudHsmClusterId; /**

Describes the connection error. This field appears in the response only when the ConnectionState is FAILED.

Many failures can be resolved by updating the properties of the custom key store. To update a custom key store, disconnect it (DisconnectCustomKeyStore), correct the errors (UpdateCustomKeyStore), and try to connect again (ConnectCustomKeyStore). For additional help resolving these errors, see How to Fix a Connection Failure in Key Management Service Developer Guide.

All custom key stores:

  • INTERNAL_ERROR — KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.

  • NETWORK_ERRORS — Network errors are preventing KMS from connecting the custom key store to its backing key store.

CloudHSM key stores:

  • CLUSTER_NOT_FOUND — KMS cannot find the CloudHSM cluster with the specified cluster ID.

  • INSUFFICIENT_CLOUDHSM_HSMS — The associated CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its CloudHSM cluster, the cluster must contain at least one active HSM.

  • INSUFFICIENT_FREE_ADDRESSES_IN_SUBNET — At least one private subnet associated with the CloudHSM cluster doesn't have any available IP addresses. A CloudHSM key store connection requires one free IP address in each of the associated private subnets, although two are preferable. For details, see How to Fix a Connection Failure in the Key Management Service Developer Guide.

  • INVALID_CREDENTIALS — The KeyStorePassword for the custom key store doesn't match the current password of the kmsuser crypto user in the CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must change the kmsuser account password and update the KeyStorePassword value for the custom key store.

  • SUBNET_NOT_FOUND — A subnet in the CloudHSM cluster configuration was deleted. If KMS cannot find all of the subnets in the cluster configuration, attempts to connect the custom key store to the CloudHSM cluster fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a Connection Failure in the Key Management Service Developer Guide.

  • USER_LOCKED_OUT — The kmsuser CU account is locked out of the associated CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its CloudHSM cluster, you must change the kmsuser account password and update the key store password value for the custom key store.

  • USER_LOGGED_IN — The kmsuser CU account is logged into the associated CloudHSM cluster. This prevents KMS from rotating the kmsuser account password and logging into the cluster. Before you can connect your custom key store to its CloudHSM cluster, you must log the kmsuser CU out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and Reconnect in the Key Management Service Developer Guide.

  • USER_NOT_FOUND — KMS cannot find a kmsuser CU account in the associated CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must create a kmsuser CU account in the cluster, and then update the key store password value for the custom key store.

External key stores:

  • INVALID_CREDENTIALS — One or both of the XksProxyAuthenticationCredential values is not valid on the specified external key store proxy.

  • XKS_PROXY_ACCESS_DENIED — KMS requests are denied access to the external key store proxy. If the external key store proxy has authorization rules, verify that they permit KMS to communicate with the proxy on your behalf.

  • XKS_PROXY_INVALID_CONFIGURATION — A configuration error is preventing the external key store from connecting to its proxy. Verify the value of the XksProxyUriPath.

  • XKS_PROXY_INVALID_RESPONSE — KMS cannot interpret the response from the external key store proxy. If you see this connection error code repeatedly, notify your external key store proxy vendor.

  • XKS_PROXY_INVALID_TLS_CONFIGURATION — KMS cannot connect to the external key store proxy because the TLS configuration is invalid. Verify that the XKS proxy supports TLS 1.2 or 1.3. Also, verify that the TLS certificate is not expired, and that it matches the hostname in the XksProxyUriEndpoint value, and that it is signed by a certificate authority included in the Trusted Certificate Authorities list.

  • XKS_PROXY_NOT_REACHABLE — KMS can't communicate with your external key store proxy. Verify that the XksProxyUriEndpoint and XksProxyUriPath are correct. Use the tools for your external key store proxy to verify that the proxy is active and available on its network. Also, verify that your external key manager instances are operating properly. Connection attempts fail with this connection error code if the proxy reports that all external key manager instances are unavailable.

  • XKS_PROXY_TIMED_OUT — KMS can connect to the external key store proxy, but the proxy does not respond to KMS in the time allotted. If you see this connection error code repeatedly, notify your external key store proxy vendor.

  • XKS_VPC_ENDPOINT_SERVICE_INVALID_CONFIGURATION — The Amazon VPC endpoint service configuration doesn't conform to the requirements for an KMS external key store.

    • The VPC endpoint service must be an endpoint service for interface endpoints in the caller's Amazon Web Services account.

    • It must have a network load balancer (NLB) connected to at least two subnets, each in a different Availability Zone.

    • The Allow principals list must include the KMS service principal for the Region, cks.kms.<region>.amazonaws.com, such as cks.kms.us-east-1.amazonaws.com.

    • It must not require acceptance of connection requests.

    • It must have a private DNS name. The private DNS name for an external key store with VPC_ENDPOINT_SERVICE connectivity must be unique in its Amazon Web Services Region.

    • The domain of the private DNS name must have a verification status of verified.

    • The TLS certificate specifies the private DNS hostname at which the endpoint is reachable.

  • XKS_VPC_ENDPOINT_SERVICE_NOT_FOUND — KMS can't find the VPC endpoint service that it uses to communicate with the external key store proxy. Verify that the XksProxyVpcEndpointServiceName is correct and the KMS service principal has service consumer permissions on the Amazon VPC endpoint service.

*/ @property (nonatomic, assign) AWSKMSConnectionErrorCodeType connectionErrorCode; /**

Indicates whether the custom key store is connected to its backing key store. For an CloudHSM key store, the ConnectionState indicates whether it is connected to its CloudHSM cluster. For an external key store, the ConnectionState indicates whether it is connected to the external key store proxy that communicates with your external key manager.

You can create and use KMS keys in your custom key stores only when its ConnectionState is CONNECTED.

The ConnectionState value is DISCONNECTED only if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that the backing key store is reachable and active. For an CloudHSM key store, verify that its associated CloudHSM cluster is active and contains at least one active HSM. For an external key store, verify that the external key store proxy and external key manager are connected and enabled.

A value of FAILED indicates that an attempt to connect was unsuccessful. The ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a connection failure, see Troubleshooting a custom key store in the Key Management Service Developer Guide.

*/ @property (nonatomic, assign) AWSKMSConnectionStateType connectionState; /**

The date and time when the custom key store was created.

*/ @property (nonatomic, strong) NSDate * _Nullable creationDate; /**

A unique identifier for the custom key store.

*/ @property (nonatomic, strong) NSString * _Nullable customKeyStoreId; /**

The user-specified friendly name for the custom key store.

*/ @property (nonatomic, strong) NSString * _Nullable customKeyStoreName; /**

Indicates the type of the custom key store. AWS_CLOUDHSM indicates a custom key store backed by an CloudHSM cluster. EXTERNAL_KEY_STORE indicates a custom key store backed by an external key store proxy and external key manager outside of Amazon Web Services.

*/ @property (nonatomic, assign) AWSKMSCustomKeyStoreType customKeyStoreType; /**

The trust anchor certificate of the CloudHSM cluster associated with an CloudHSM key store. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.

This field appears only when the CustomKeyStoreType is AWS_CLOUDHSM.

*/ @property (nonatomic, strong) NSString * _Nullable trustAnchorCertificate; /**

Configuration settings for the external key store proxy (XKS proxy). The external key store proxy translates KMS requests into a format that your external key manager can understand. The proxy configuration includes connection information that KMS requires.

This field appears only when the CustomKeyStoreType is EXTERNAL_KEY_STORE.

*/ @property (nonatomic, strong) AWSKMSXksProxyConfigurationType * _Nullable xksProxyConfiguration; @end /** */ @interface AWSKMSDecryptRequest : AWSRequest /**

Ciphertext to be decrypted. The blob includes metadata.

*/ @property (nonatomic, strong) NSData * _Nullable ciphertextBlob; /**

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

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

*/ @property (nonatomic, strong) NSNumber * _Nullable dryRun; /**

Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails.

This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric encryption KMS keys.

*/ @property (nonatomic, assign) AWSKMSEncryptionAlgorithmSpec encryptionAlgorithm; /**

Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric encryption KMS key. The standard asymmetric encryption algorithms and HMAC algorithms that KMS uses do not support an encryption context.

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

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

*/ @property (nonatomic, strong) NSDictionary * _Nullable encryptionContext; /**

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

*/ @property (nonatomic, strong) NSArray * _Nullable grantTokens; /**

Specifies the KMS key that KMS uses to decrypt the ciphertext.

Enter a key ID of the KMS key that was used to encrypt the ciphertext. If you identify a different KMS key, the Decrypt operation throws an IncorrectKeyException.

This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key. If you used a symmetric encryption KMS key, KMS can get the KMS key from metadata that it adds to the symmetric ciphertext blob. However, it is always recommended as a best practice. This practice ensures that you use the KMS key that you intend.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

*/ @property (nonatomic, strong) NSString * _Nullable keyId; /**

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

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

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

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

*/ @property (nonatomic, strong) AWSKMSRecipientInfo * _Nullable recipient; @end /** */ @interface AWSKMSDecryptResponse : AWSModel /**

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

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

*/ @property (nonatomic, strong) NSData * _Nullable ciphertextForRecipient; /**

The encryption algorithm that was used to decrypt the ciphertext.

*/ @property (nonatomic, assign) AWSKMSEncryptionAlgorithmSpec encryptionAlgorithm; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable keyId; /**

Decrypted plaintext data. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

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

*/ @property (nonatomic, strong) NSData * _Nullable plaintext; @end /** */ @interface AWSKMSDeleteAliasRequest : AWSRequest /**

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

*/ @property (nonatomic, strong) NSString * _Nullable aliasName; @end /** */ @interface AWSKMSDeleteCustomKeyStoreRequest : AWSRequest /**

Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

*/ @property (nonatomic, strong) NSString * _Nullable customKeyStoreId; @end /** */ @interface AWSKMSDeleteCustomKeyStoreResponse : AWSModel @end /** */ @interface AWSKMSDeleteImportedKeyMaterialRequest : AWSRequest /**

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

Specify the key ID or key ARN of the KMS key.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

*/ @property (nonatomic, strong) NSString * _Nullable keyId; @end /** */ @interface AWSKMSDescribeCustomKeyStoresRequest : AWSRequest /**

Gets only information about the specified custom key store. Enter the key store ID.

By default, this operation gets information about all custom key stores in the account and Region. To limit the output to a particular custom key store, provide either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

*/ @property (nonatomic, strong) NSString * _Nullable customKeyStoreId; /**

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

By default, this operation gets information about all custom key stores in the account and Region. To limit the output to a particular custom key store, provide either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

*/ @property (nonatomic, strong) NSString * _Nullable customKeyStoreName; /**

Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.

*/ @property (nonatomic, strong) NSNumber * _Nullable limit; /**

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

*/ @property (nonatomic, strong) NSString * _Nullable marker; @end /** */ @interface AWSKMSDescribeCustomKeyStoresResponse : AWSModel /**

Contains metadata about each custom key store.

*/ @property (nonatomic, strong) NSArray * _Nullable customKeyStores; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable nextMarker; /**

A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.

*/ @property (nonatomic, strong) NSNumber * _Nullable truncated; @end /** */ @interface AWSKMSDescribeKeyRequest : AWSRequest /**

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

*/ @property (nonatomic, strong) NSArray * _Nullable grantTokens; /**

Describes the specified KMS key.

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

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

*/ @property (nonatomic, strong) NSString * _Nullable keyId; @end /** */ @interface AWSKMSDescribeKeyResponse : AWSModel /**

Metadata associated with the key.

*/ @property (nonatomic, strong) AWSKMSKeyMetadata * _Nullable keyMetadata; @end /** */ @interface AWSKMSDisableKeyRequest : AWSRequest /**

Identifies the KMS key to disable.

Specify the key ID or key ARN of the KMS key.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

*/ @property (nonatomic, strong) NSString * _Nullable keyId; @end /** */ @interface AWSKMSDisableKeyRotationRequest : AWSRequest /**

Identifies a symmetric encryption KMS key. You cannot enable or disable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store.

Specify the key ID or key ARN of the KMS key.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

*/ @property (nonatomic, strong) NSString * _Nullable keyId; @end /** */ @interface AWSKMSDisconnectCustomKeyStoreRequest : AWSRequest /**

Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

*/ @property (nonatomic, strong) NSString * _Nullable customKeyStoreId; @end /** */ @interface AWSKMSDisconnectCustomKeyStoreResponse : AWSModel @end /** */ @interface AWSKMSEnableKeyRequest : AWSRequest /**

Identifies the KMS key to enable.

Specify the key ID or key ARN of the KMS key.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

*/ @property (nonatomic, strong) NSString * _Nullable keyId; @end /** */ @interface AWSKMSEnableKeyRotationRequest : AWSRequest /**

Identifies a symmetric encryption KMS key. You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.

Specify the key ID or key ARN of the KMS key.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

*/ @property (nonatomic, strong) NSString * _Nullable keyId; @end /** */ @interface AWSKMSEncryptRequest : AWSRequest /**

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

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

*/ @property (nonatomic, strong) NSNumber * _Nullable dryRun; /**

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

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

The SM2PKE algorithm is only available in China Regions.

*/ @property (nonatomic, assign) AWSKMSEncryptionAlgorithmSpec encryptionAlgorithm; /**

Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations with a symmetric encryption KMS key. The standard asymmetric encryption algorithms and HMAC algorithms that KMS uses do not support an encryption context.

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

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

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

*/ @property (nonatomic, strong) NSDictionary * _Nullable encryptionContext; /**

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

*/ @property (nonatomic, strong) NSArray * _Nullable grantTokens; /**

Identifies the KMS key to use in the encryption operation. The KMS key must have a KeyUsage of ENCRYPT_DECRYPT. To find the KeyUsage of a KMS key, use the DescribeKey operation.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

*/ @property (nonatomic, strong) NSString * _Nullable keyId; /**

Data to be encrypted.

*/ @property (nonatomic, strong) NSData * _Nullable plaintext; @end /** */ @interface AWSKMSEncryptResponse : AWSModel /**

The encrypted plaintext. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

*/ @property (nonatomic, strong) NSData * _Nullable ciphertextBlob; /**

The encryption algorithm that was used to encrypt the plaintext.

*/ @property (nonatomic, assign) AWSKMSEncryptionAlgorithmSpec encryptionAlgorithm; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable keyId; @end /** */ @interface AWSKMSGenerateDataKeyPairRequest : AWSRequest /**

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

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

*/ @property (nonatomic, strong) NSNumber * _Nullable dryRun; /**

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

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

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

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

*/ @property (nonatomic, strong) NSDictionary * _Nullable encryptionContext; /**

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

*/ @property (nonatomic, strong) NSArray * _Nullable grantTokens; /**

Specifies the symmetric encryption KMS key that encrypts the private key in the data key pair. You cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

*/ @property (nonatomic, strong) NSString * _Nullable keyId; /**

Determines the type of data key pair that is generated.

The KMS rule that restricts the use of asymmetric RSA and SM2 KMS keys to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC KMS keys only to sign and verify, are not effective on data key pairs, which are used outside of KMS. The SM2 key spec is only available in China Regions.

*/ @property (nonatomic, assign) AWSKMSDataKeyPairSpec keyPairSpec; /**

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

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

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

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

*/ @property (nonatomic, strong) AWSKMSRecipientInfo * _Nullable recipient; @end /** */ @interface AWSKMSGenerateDataKeyPairResponse : AWSModel /**

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

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

*/ @property (nonatomic, strong) NSData * _Nullable ciphertextForRecipient; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable keyId; /**

The type of data key pair that was generated.

*/ @property (nonatomic, assign) AWSKMSDataKeyPairSpec keyPairSpec; /**

The encrypted copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

*/ @property (nonatomic, strong) NSData * _Nullable privateKeyCiphertextBlob; /**

The plaintext copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

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

*/ @property (nonatomic, strong) NSData * _Nullable privateKeyPlaintext; /**

The public key (in plaintext). When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

*/ @property (nonatomic, strong) NSData * _Nullable publicKey; @end /** */ @interface AWSKMSGenerateDataKeyPairWithoutPlaintextRequest : AWSRequest /**

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

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

*/ @property (nonatomic, strong) NSNumber * _Nullable dryRun; /**

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

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

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

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

*/ @property (nonatomic, strong) NSDictionary * _Nullable encryptionContext; /**

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

*/ @property (nonatomic, strong) NSArray * _Nullable grantTokens; /**

Specifies the symmetric encryption KMS key that encrypts the private key in the data key pair. You cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

*/ @property (nonatomic, strong) NSString * _Nullable keyId; /**

Determines the type of data key pair that is generated.

The KMS rule that restricts the use of asymmetric RSA and SM2 KMS keys to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC KMS keys only to sign and verify, are not effective on data key pairs, which are used outside of KMS. The SM2 key spec is only available in China Regions.

*/ @property (nonatomic, assign) AWSKMSDataKeyPairSpec keyPairSpec; @end /** */ @interface AWSKMSGenerateDataKeyPairWithoutPlaintextResponse : AWSModel /**

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

*/ @property (nonatomic, strong) NSString * _Nullable keyId; /**

The type of data key pair that was generated.

*/ @property (nonatomic, assign) AWSKMSDataKeyPairSpec keyPairSpec; /**

The encrypted copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

*/ @property (nonatomic, strong) NSData * _Nullable privateKeyCiphertextBlob; /**

The public key (in plaintext). When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

*/ @property (nonatomic, strong) NSData * _Nullable publicKey; @end /** */ @interface AWSKMSGenerateDataKeyRequest : AWSRequest /**

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

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

*/ @property (nonatomic, strong) NSNumber * _Nullable dryRun; /**

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

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

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

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

*/ @property (nonatomic, strong) NSDictionary * _Nullable encryptionContext; /**

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

*/ @property (nonatomic, strong) NSArray * _Nullable grantTokens; /**

Specifies the symmetric encryption KMS key that encrypts the data key. You cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

*/ @property (nonatomic, strong) NSString * _Nullable keyId; /**

Specifies the length of the data key. Use AES_128 to generate a 128-bit symmetric key, or AES_256 to generate a 256-bit symmetric key.

You must specify either the KeySpec or the NumberOfBytes parameter (but not both) in every GenerateDataKey request.

*/ @property (nonatomic, assign) AWSKMSDataKeySpec keySpec; /**

Specifies the length of the data key in bytes. For example, use the value 64 to generate a 512-bit data key (64 bytes is 512 bits). For 128-bit (16-byte) and 256-bit (32-byte) data keys, use the KeySpec parameter.

You must specify either the KeySpec or the NumberOfBytes parameter (but not both) in every GenerateDataKey request.

*/ @property (nonatomic, strong) NSNumber * _Nullable numberOfBytes; /**

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

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

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

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

*/ @property (nonatomic, strong) AWSKMSRecipientInfo * _Nullable recipient; @end /** */ @interface AWSKMSGenerateDataKeyResponse : AWSModel /**

The encrypted copy of the data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

*/ @property (nonatomic, strong) NSData * _Nullable ciphertextBlob; /**

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

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

*/ @property (nonatomic, strong) NSData * _Nullable ciphertextForRecipient; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable keyId; /**

The plaintext data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded. Use this data key to encrypt your data outside of KMS. Then, remove it from memory as soon as possible.

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

*/ @property (nonatomic, strong) NSData * _Nullable plaintext; @end /** */ @interface AWSKMSGenerateDataKeyWithoutPlaintextRequest : AWSRequest /**

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

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

*/ @property (nonatomic, strong) NSNumber * _Nullable dryRun; /**

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

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

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

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

*/ @property (nonatomic, strong) NSDictionary * _Nullable encryptionContext; /**

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

*/ @property (nonatomic, strong) NSArray * _Nullable grantTokens; /**

Specifies the symmetric encryption KMS key that encrypts the data key. You cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

*/ @property (nonatomic, strong) NSString * _Nullable keyId; /**

The length of the data key. Use AES_128 to generate a 128-bit symmetric key, or AES_256 to generate a 256-bit symmetric key.

*/ @property (nonatomic, assign) AWSKMSDataKeySpec keySpec; /**

The length of the data key in bytes. For example, use the value 64 to generate a 512-bit data key (64 bytes is 512 bits). For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use the KeySpec field instead of this one.

*/ @property (nonatomic, strong) NSNumber * _Nullable numberOfBytes; @end /** */ @interface AWSKMSGenerateDataKeyWithoutPlaintextResponse : AWSModel /**

The encrypted data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

*/ @property (nonatomic, strong) NSData * _Nullable ciphertextBlob; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable keyId; @end /** */ @interface AWSKMSGenerateMacRequest : AWSRequest /**

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

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

*/ @property (nonatomic, strong) NSNumber * _Nullable dryRun; /**

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

*/ @property (nonatomic, strong) NSArray * _Nullable grantTokens; /**

The HMAC KMS key to use in the operation. The MAC algorithm computes the HMAC for the message and the key as described in RFC 2104.

To identify an HMAC KMS key, use the DescribeKey operation and see the KeySpec field in the response.

*/ @property (nonatomic, strong) NSString * _Nullable keyId; /**

The MAC algorithm used in the operation.

The algorithm must be compatible with the HMAC KMS key that you specify. To find the MAC algorithms that your HMAC KMS key supports, use the DescribeKey operation and see the MacAlgorithms field in the DescribeKey response.

*/ @property (nonatomic, assign) AWSKMSMacAlgorithmSpec macAlgorithm; /**

The message to be hashed. Specify a message of up to 4,096 bytes.

GenerateMac and VerifyMac do not provide special handling for message digests. If you generate an HMAC for a hash digest of a message, you must verify the HMAC of the same hash digest.

*/ @property (nonatomic, strong) NSData * _Nullable message; @end /** */ @interface AWSKMSGenerateMacResponse : AWSModel /**

The HMAC KMS key used in the operation.

*/ @property (nonatomic, strong) NSString * _Nullable keyId; /**

The hash-based message authentication code (HMAC) that was generated for the specified message, HMAC KMS key, and MAC algorithm.

This is the standard, raw HMAC defined in RFC 2104.

*/ @property (nonatomic, strong) NSData * _Nullable mac; /**

The MAC algorithm that was used to generate the HMAC.

*/ @property (nonatomic, assign) AWSKMSMacAlgorithmSpec macAlgorithm; @end /** */ @interface AWSKMSGenerateRandomRequest : AWSRequest /**

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

External key store IDs are not valid for this parameter. If you specify the ID of an external key store, GenerateRandom throws an UnsupportedOperationException.

*/ @property (nonatomic, strong) NSString * _Nullable customKeyStoreId; /**

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

*/ @property (nonatomic, strong) NSNumber * _Nullable numberOfBytes; /**

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

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

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

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

*/ @property (nonatomic, strong) AWSKMSRecipientInfo * _Nullable recipient; @end /** */ @interface AWSKMSGenerateRandomResponse : AWSModel /**

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

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

*/ @property (nonatomic, strong) NSData * _Nullable ciphertextForRecipient; /**

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

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

*/ @property (nonatomic, strong) NSData * _Nullable plaintext; @end /** */ @interface AWSKMSGetKeyPolicyRequest : AWSRequest /**

Gets the key policy for the specified KMS key.

Specify the key ID or key ARN of the KMS key.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

*/ @property (nonatomic, strong) NSString * _Nullable keyId; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable policyName; @end /** */ @interface AWSKMSGetKeyPolicyResponse : AWSModel /**

A key policy document in JSON format.

*/ @property (nonatomic, strong) NSString * _Nullable policy; @end /** */ @interface AWSKMSGetKeyRotationStatusRequest : AWSRequest /**

Gets the rotation status for the specified KMS key.

Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

*/ @property (nonatomic, strong) NSString * _Nullable keyId; @end /** */ @interface AWSKMSGetKeyRotationStatusResponse : AWSModel /**

A Boolean value that specifies whether key rotation is enabled.

*/ @property (nonatomic, strong) NSNumber * _Nullable keyRotationEnabled; @end /** */ @interface AWSKMSGetParametersForImportRequest : AWSRequest /**

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

All KMS key types are supported, including multi-Region keys. However, you cannot import key material into a KMS key in a custom key store.

Specify the key ID or key ARN of the KMS key.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

*/ @property (nonatomic, strong) NSString * _Nullable keyId; /**

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

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

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

  • RSA_AES_KEY_WRAP_SHA_256 — Supported for wrapping RSA and ECC key material.

  • RSA_AES_KEY_WRAP_SHA_1 — Supported for wrapping RSA and ECC key material.

  • RSAES_OAEP_SHA_256 — Supported for all types of key material, except RSA key material (private key).

    You cannot use the RSAES_OAEP_SHA_256 wrapping algorithm with the RSA_2048 wrapping key spec to wrap ECC_NIST_P521 key material.

  • RSAES_OAEP_SHA_1 — Supported for all types of key material, except RSA key material (private key).

    You cannot use the RSAES_OAEP_SHA_1 wrapping algorithm with the RSA_2048 wrapping key spec to wrap ECC_NIST_P521 key material.

  • RSAES_PKCS1_V1_5 (Deprecated) — Supported only for symmetric encryption key material (and only in legacy mode).

*/ @property (nonatomic, assign) AWSKMSAlgorithmSpec wrappingAlgorithm; /**

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

Use the longest RSA wrapping key that is practical.

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

*/ @property (nonatomic, assign) AWSKMSWrappingKeySpec wrappingKeySpec; @end /** */ @interface AWSKMSGetParametersForImportResponse : AWSModel /**

The import token to send in a subsequent ImportKeyMaterial request.

*/ @property (nonatomic, strong) NSData * _Nullable importToken; /**

The Amazon Resource Name (key ARN) of the KMS key to use in a subsequent ImportKeyMaterial request. This is the same KMS key specified in the GetParametersForImport request.

*/ @property (nonatomic, strong) NSString * _Nullable keyId; /**

The time at which the import token and public key are no longer valid. After this time, you cannot use them to make an ImportKeyMaterial request and you must send another GetParametersForImport request to get new ones.

*/ @property (nonatomic, strong) NSDate * _Nullable parametersValidTo; /**

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

*/ @property (nonatomic, strong) NSData * _Nullable publicKey; @end /** */ @interface AWSKMSGetPublicKeyRequest : AWSRequest /**

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

*/ @property (nonatomic, strong) NSArray * _Nullable grantTokens; /**

Identifies the asymmetric KMS key that includes the public key.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

*/ @property (nonatomic, strong) NSString * _Nullable keyId; @end /** */ @interface AWSKMSGetPublicKeyResponse : AWSModel /**

Instead, use the KeySpec field in the GetPublicKey response.

The KeySpec and CustomerMasterKeySpec fields have the same value. We recommend that you use the KeySpec field in your code. However, to avoid breaking changes, KMS supports both fields.

*/ @property (nonatomic, assign) AWSKMSCustomerMasterKeySpec customerMasterKeySpec; /**

The encryption algorithms that KMS supports for this key.

This information is critical. If a public key encrypts data outside of KMS by using an unsupported encryption algorithm, the ciphertext cannot be decrypted.

This field appears in the response only when the KeyUsage of the public key is ENCRYPT_DECRYPT.

*/ @property (nonatomic, strong) NSArray * _Nullable encryptionAlgorithms; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable keyId; /**

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

*/ @property (nonatomic, assign) AWSKMSKeySpec keySpec; /**

The permitted use of the public key. Valid values are ENCRYPT_DECRYPT or SIGN_VERIFY.

This information is critical. If a public key with SIGN_VERIFY key usage encrypts data outside of KMS, the ciphertext cannot be decrypted.

*/ @property (nonatomic, assign) AWSKMSKeyUsageType keyUsage; /**

The exported public key.

The value is a DER-encoded X.509 public key, also known as SubjectPublicKeyInfo (SPKI), as defined in RFC 5280. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

*/ @property (nonatomic, strong) NSData * _Nullable publicKey; /**

The signing algorithms that KMS supports for this key.

This field appears in the response only when the KeyUsage of the public key is SIGN_VERIFY.

*/ @property (nonatomic, strong) NSArray * _Nullable signingAlgorithms; @end /**

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

KMS applies the grant constraints only to cryptographic operations that support an encryption context, that is, all cryptographic operations with a symmetric KMS key. Grant constraints are not applied to operations that do not support an encryption context, such as cryptographic operations with asymmetric KMS keys and management operations, such as DescribeKey or RetireGrant.

In a cryptographic operation, the encryption context in the decryption operation must be an exact, case-sensitive match for the keys and values in the encryption context of the encryption operation. Only the order of the pairs can vary.

However, in a grant constraint, the key in each key-value pair is not case sensitive, but the value is case sensitive.

To avoid confusion, do not use multiple encryption context pairs that differ only by case. To require a fully case-sensitive encryption context, use the kms:EncryptionContext: and kms:EncryptionContextKeys conditions in an IAM or key policy. For details, see kms:EncryptionContext: in the Key Management Service Developer Guide.

 */ @interface AWSKMSGrantConstraints : AWSModel /**

A list of key-value pairs that must match the encryption context in the cryptographic operation request. The grant allows the operation only when the encryption context in the request is the same as the encryption context specified in this constraint.

*/ @property (nonatomic, strong) NSDictionary * _Nullable encryptionContextEquals; /**

A list of key-value pairs that must be included in the encryption context of the cryptographic operation request. The grant allows the cryptographic operation only when the encryption context in the request includes the key-value pairs specified in this constraint, although it can include additional key-value pairs.

*/ @property (nonatomic, strong) NSDictionary * _Nullable encryptionContextSubset; @end /**

Contains information about a grant.

*/ @interface AWSKMSGrantListEntry : AWSModel /**

A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows.

*/ @property (nonatomic, strong) AWSKMSGrantConstraints * _Nullable constraints; /**

The date and time when the grant was created.

*/ @property (nonatomic, strong) NSDate * _Nullable creationDate; /**

The unique identifier for the grant.

*/ @property (nonatomic, strong) NSString * _Nullable grantId; /**

The identity that gets the permissions in the grant.

The GranteePrincipal field in the ListGrants response usually contains the user or role designated as the grantee principal in the grant. However, when the grantee principal in the grant is an Amazon Web Services service, the GranteePrincipal field contains the service principal, which might represent several different grantee principals.

*/ @property (nonatomic, strong) NSString * _Nullable granteePrincipal; /**

The Amazon Web Services account under which the grant was issued.

*/ @property (nonatomic, strong) NSString * _Nullable issuingAccount; /**

The unique identifier for the KMS key to which the grant applies.

*/ @property (nonatomic, strong) NSString * _Nullable keyId; /**

The friendly name that identifies the grant. If a name was provided in the CreateGrant request, that name is returned. Otherwise this value is null.

*/ @property (nonatomic, strong) NSString * _Nullable name; /**

The list of operations permitted by the grant.

*/ @property (nonatomic, strong) NSArray * _Nullable operations; /**

The principal that can retire the grant.

*/ @property (nonatomic, strong) NSString * _Nullable retiringPrincipal; @end /** */ @interface AWSKMSImportKeyMaterialRequest : AWSRequest /**

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

*/ @property (nonatomic, strong) NSData * _Nullable encryptedKeyMaterial; /**

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

When the value of ExpirationModel is KEY_MATERIAL_EXPIRES, you must specify a value for the ValidTo parameter. When value is KEY_MATERIAL_DOES_NOT_EXPIRE, you must omit the ValidTo parameter.

You cannot change the ExpirationModel or ValidTo values for the current import after the request completes. To change either value, you must reimport the key material.

*/ @property (nonatomic, assign) AWSKMSExpirationModelType expirationModel; /**

The import token that you received in the response to a previous GetParametersForImport request. It must be from the same response that contained the public key that you used to encrypt the key material.

*/ @property (nonatomic, strong) NSData * _Nullable importToken; /**

The identifier of the KMS key that will be associated with the imported key material. This must be the same KMS key specified in the KeyID parameter of the corresponding GetParametersForImport request. The Origin of the KMS key must be EXTERNAL and its KeyState must be PendingImport.

The KMS key can be a symmetric encryption KMS key, HMAC KMS key, asymmetric encryption KMS key, or asymmetric signing KMS key, including a multi-Region key of any supported type. You cannot perform this operation on a KMS key in a custom key store, or on a KMS key in a different Amazon Web Services account.

Specify the key ID or key ARN of the KMS key.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

*/ @property (nonatomic, strong) NSString * _Nullable keyId; /**

The date and time when the imported key material expires. This parameter is required when the value of the ExpirationModel parameter is KEY_MATERIAL_EXPIRES. Otherwise it is not valid.

The value of this parameter must be a future date and time. The maximum value is 365 days from the request date.

When the key material expires, KMS deletes the key material from the KMS key. Without its key material, the KMS key is unusable. To use the KMS key in cryptographic operations, you must reimport the same key material.

You cannot change the ExpirationModel or ValidTo values for the current import after the request completes. To change either value, you must delete (DeleteImportedKeyMaterial) and reimport the key material.

*/ @property (nonatomic, strong) NSDate * _Nullable validTo; @end /** */ @interface AWSKMSImportKeyMaterialResponse : AWSModel @end /**

Contains information about each entry in the key list.

*/ @interface AWSKMSKeyListEntry : AWSModel /**

ARN of the key.

*/ @property (nonatomic, strong) NSString * _Nullable keyArn; /**

Unique identifier of the key.

*/ @property (nonatomic, strong) NSString * _Nullable keyId; @end /**

Contains metadata about a KMS key.

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

Required parameters: [KeyId] */ @interface AWSKMSKeyMetadata : AWSModel /**

The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.

*/ @property (nonatomic, strong) NSString * _Nullable AWSAccountId; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable arn; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable cloudHsmClusterId; /**

The date and time when the KMS key was created.

*/ @property (nonatomic, strong) NSDate * _Nullable creationDate; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable customKeyStoreId; /**

Instead, use the KeySpec field.

The KeySpec and CustomerMasterKeySpec fields have the same value. We recommend that you use the KeySpec field in your code. However, to avoid breaking changes, KMS supports both fields.

*/ @property (nonatomic, assign) AWSKMSCustomerMasterKeySpec customerMasterKeySpec; /**

The date and time after which KMS deletes this KMS key. This value is present only when the KMS key is scheduled for deletion, that is, when its KeyState is PendingDeletion.

When the primary key in a multi-Region key is scheduled for deletion but still has replica keys, its key state is PendingReplicaDeletion and the length of its waiting period is displayed in the PendingDeletionWindowInDays field.

*/ @property (nonatomic, strong) NSDate * _Nullable deletionDate; /**

The description of the KMS key.

*/ @property (nonatomic, strong) NSString * _Nullable detail; /**

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

*/ @property (nonatomic, strong) NSNumber * _Nullable enabled; /**

The encryption algorithms that the KMS key supports. You cannot use the KMS key with other encryption algorithms within KMS.

This value is present only when the KeyUsage of the KMS key is ENCRYPT_DECRYPT.

*/ @property (nonatomic, strong) NSArray * _Nullable encryptionAlgorithms; /**

Specifies whether the KMS key's key material expires. This value is present only when Origin is EXTERNAL, otherwise this value is omitted.

*/ @property (nonatomic, assign) AWSKMSExpirationModelType expirationModel; /**

The globally unique identifier for the KMS key.

*/ @property (nonatomic, strong) NSString * _Nullable keyId; /**

The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed. For more information about the difference, see KMS keys in the Key Management Service Developer Guide.

*/ @property (nonatomic, assign) AWSKMSKeyManagerType keyManager; /**

Describes the type of key material in the KMS key.

*/ @property (nonatomic, assign) AWSKMSKeySpec keySpec; /**

The current status of the KMS key.

For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the Key Management Service Developer Guide.

*/ @property (nonatomic, assign) AWSKMSKeyState keyState; /**

The cryptographic operations for which you can use the KMS key.

*/ @property (nonatomic, assign) AWSKMSKeyUsageType keyUsage; /**

The message authentication code (MAC) algorithm that the HMAC KMS key supports.

This value is present only when the KeyUsage of the KMS key is GENERATE_VERIFY_MAC.

*/ @property (nonatomic, strong) NSArray * _Nullable macAlgorithms; /**

Indicates whether the KMS key is a multi-Region (True) or regional (False) key. This value is True for multi-Region primary and replica keys and False for regional KMS keys.

For more information about multi-Region keys, see Multi-Region keys in KMS in the Key Management Service Developer Guide.

*/ @property (nonatomic, strong) NSNumber * _Nullable multiRegion; /**

Lists the primary and replica keys in same multi-Region key. This field is present only when the value of the MultiRegion field is True.

For more information about any listed KMS key, use the DescribeKey operation.

  • MultiRegionKeyType indicates whether the KMS key is a PRIMARY or REPLICA key.

  • PrimaryKey displays the key ARN and Region of the primary key. This field displays the current KMS key if it is the primary key.

  • ReplicaKeys displays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica key.

*/ @property (nonatomic, strong) AWSKMSMultiRegionConfiguration * _Nullable multiRegionConfiguration; /**

The source of the key material for the KMS key. When this value is AWS_KMS, KMS created the key material. When this value is EXTERNAL, the key material was imported or the KMS key doesn't have any key material. When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster associated with a custom key store.

*/ @property (nonatomic, assign) AWSKMSOriginType origin; /**

The waiting period before the primary key in a multi-Region key is deleted. This waiting period begins when the last of its replica keys is deleted. This value is present only when the KeyState of the KMS key is PendingReplicaDeletion. That indicates that the KMS key is the primary key in a multi-Region key, it is scheduled for deletion, and it still has existing replica keys.

When a single-Region KMS key or a multi-Region replica key is scheduled for deletion, its deletion date is displayed in the DeletionDate field. However, when the primary key in a multi-Region key is scheduled for deletion, its waiting period doesn't begin until all of its replica keys are deleted. This value displays that waiting period. When the last replica key in the multi-Region key is deleted, the KeyState of the scheduled primary key changes from PendingReplicaDeletion to PendingDeletion and the deletion date appears in the DeletionDate field.

*/ @property (nonatomic, strong) NSNumber * _Nullable pendingDeletionWindowInDays; /**

The signing algorithms that the KMS key supports. You cannot use the KMS key with other signing algorithms within KMS.

This field appears only when the KeyUsage of the KMS key is SIGN_VERIFY.

*/ @property (nonatomic, strong) NSArray * _Nullable signingAlgorithms; /**

The time at which the imported key material expires. When the key material expires, KMS deletes the key material and the KMS key becomes unusable. This value is present only for KMS keys whose Origin is EXTERNAL and whose ExpirationModel is KEY_MATERIAL_EXPIRES, otherwise this value is omitted.

*/ @property (nonatomic, strong) NSDate * _Nullable validTo; /**

Information about the external key that is associated with a KMS key in an external key store.

For more information, see External key in the Key Management Service Developer Guide.

*/ @property (nonatomic, strong) AWSKMSXksKeyConfigurationType * _Nullable xksKeyConfiguration; @end /** */ @interface AWSKMSListAliasesRequest : AWSRequest /**

Lists only aliases that are associated with the specified KMS key. Enter a KMS key in your Amazon Web Services account.

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

Specify the key ID or key ARN of the KMS key.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

*/ @property (nonatomic, strong) NSString * _Nullable keyId; /**

Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.

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

*/ @property (nonatomic, strong) NSNumber * _Nullable limit; /**

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

*/ @property (nonatomic, strong) NSString * _Nullable marker; @end /** */ @interface AWSKMSListAliasesResponse : AWSModel /**

A list of aliases.

*/ @property (nonatomic, strong) NSArray * _Nullable aliases; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable nextMarker; /**

A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.

*/ @property (nonatomic, strong) NSNumber * _Nullable truncated; @end /** */ @interface AWSKMSListGrantsRequest : AWSRequest /**

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

*/ @property (nonatomic, strong) NSString * _Nullable grantId; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable granteePrincipal; /**

Returns only grants for the specified KMS key. This parameter is required.

Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

*/ @property (nonatomic, strong) NSString * _Nullable keyId; /**

Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.

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

*/ @property (nonatomic, strong) NSNumber * _Nullable limit; /**

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

*/ @property (nonatomic, strong) NSString * _Nullable marker; @end /** */ @interface AWSKMSListGrantsResponse : AWSModel /**

A list of grants.

*/ @property (nonatomic, strong) NSArray * _Nullable grants; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable nextMarker; /**

A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.

*/ @property (nonatomic, strong) NSNumber * _Nullable truncated; @end /** */ @interface AWSKMSListKeyPoliciesRequest : AWSRequest /**

Gets the names of key policies for the specified KMS key.

Specify the key ID or key ARN of the KMS key.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

*/ @property (nonatomic, strong) NSString * _Nullable keyId; /**

Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.

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

Only one policy can be attached to a key.

*/ @property (nonatomic, strong) NSNumber * _Nullable limit; /**

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

*/ @property (nonatomic, strong) NSString * _Nullable marker; @end /** */ @interface AWSKMSListKeyPoliciesResponse : AWSModel /**

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

*/ @property (nonatomic, strong) NSString * _Nullable nextMarker; /**

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

*/ @property (nonatomic, strong) NSArray * _Nullable policyNames; /**

A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.

*/ @property (nonatomic, strong) NSNumber * _Nullable truncated; @end /** */ @interface AWSKMSListKeysRequest : AWSRequest /**

Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.

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

*/ @property (nonatomic, strong) NSNumber * _Nullable limit; /**

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

*/ @property (nonatomic, strong) NSString * _Nullable marker; @end /** */ @interface AWSKMSListKeysResponse : AWSModel /**

A list of KMS keys.

*/ @property (nonatomic, strong) NSArray * _Nullable keys; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable nextMarker; /**

A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.

*/ @property (nonatomic, strong) NSNumber * _Nullable truncated; @end /** */ @interface AWSKMSListResourceTagsRequest : AWSRequest /**

Gets tags on the specified KMS key.

Specify the key ID or key ARN of the KMS key.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

*/ @property (nonatomic, strong) NSString * _Nullable keyId; /**

Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.

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

*/ @property (nonatomic, strong) NSNumber * _Nullable limit; /**

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

Do not attempt to construct this value. Use only the value of NextMarker from the truncated response you just received.

*/ @property (nonatomic, strong) NSString * _Nullable marker; @end /** */ @interface AWSKMSListResourceTagsResponse : AWSModel /**

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

Do not assume or infer any information from this value.

*/ @property (nonatomic, strong) NSString * _Nullable nextMarker; /**

A list of tags. Each tag consists of a tag key and a tag value.

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management Service Developer Guide.

 */ @property (nonatomic, strong) NSArray * _Nullable tags; /**

A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.

*/ @property (nonatomic, strong) NSNumber * _Nullable truncated; @end /** */ @interface AWSKMSListRetirableGrantsRequest : AWSRequest /**

Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.

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

*/ @property (nonatomic, strong) NSNumber * _Nullable limit; /**

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

*/ @property (nonatomic, strong) NSString * _Nullable marker; /**

The retiring principal for which to list grants. Enter a principal in your Amazon Web Services account.

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

*/ @property (nonatomic, strong) NSString * _Nullable retiringPrincipal; @end /**

Describes the configuration of this multi-Region key. This field appears only when the KMS key is a primary or replica of a multi-Region key.

For more information about any listed KMS key, use the DescribeKey operation.

*/ @interface AWSKMSMultiRegionConfiguration : AWSModel /**

Indicates whether the KMS key is a PRIMARY or REPLICA key.

*/ @property (nonatomic, assign) AWSKMSMultiRegionKeyType multiRegionKeyType; /**

Displays the key ARN and Region of the primary key. This field includes the current KMS key if it is the primary key.

*/ @property (nonatomic, strong) AWSKMSMultiRegionKey * _Nullable primaryKey; /**

displays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica key.

*/ @property (nonatomic, strong) NSArray * _Nullable replicaKeys; @end /**

Describes the primary or replica key in a multi-Region key.

*/ @interface AWSKMSMultiRegionKey : AWSModel /**

Displays the key ARN of a primary or replica key of a multi-Region key.

*/ @property (nonatomic, strong) NSString * _Nullable arn; /**

Displays the Amazon Web Services Region of a primary or replica key in a multi-Region key.

*/ @property (nonatomic, strong) NSString * _Nullable region; @end /** */ @interface AWSKMSPutKeyPolicyRequest : AWSRequest /**

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

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

For more information, see Default key policy in the Key Management Service Developer Guide.

Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.

*/ @property (nonatomic, strong) NSNumber * _Nullable bypassPolicyLockoutSafetyCheck; /**

Sets the key policy on the specified KMS key.

Specify the key ID or key ARN of the KMS key.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

*/ @property (nonatomic, strong) NSString * _Nullable keyId; /**

The key policy to attach to the KMS key.

The key policy must meet the following criteria:

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

  • Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal, you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services Identity and Access Management User Guide.

A key policy document can include only the following characters:

  • Printable ASCII characters from the space character (\u0020) through the end of the ASCII character range.

  • Printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF).

  • The tab (\u0009), line feed (\u000A), and carriage return (\u000D) special characters

For information about key policies, see Key policies in KMS in the Key Management Service Developer Guide.For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the Identity and Access Management User Guide.

*/ @property (nonatomic, strong) NSString * _Nullable policy; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable policyName; @end /** */ @interface AWSKMSReEncryptRequest : AWSRequest /**

Ciphertext of the data to reencrypt.

*/ @property (nonatomic, strong) NSData * _Nullable ciphertextBlob; /**

Specifies the encryption algorithm that KMS will use to reecrypt the data after it has decrypted it. The default value, SYMMETRIC_DEFAULT, represents the encryption algorithm used for symmetric encryption KMS keys.

This parameter is required only when the destination KMS key is an asymmetric KMS key.

*/ @property (nonatomic, assign) AWSKMSEncryptionAlgorithmSpec destinationEncryptionAlgorithm; /**

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

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

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

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

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

*/ @property (nonatomic, strong) NSDictionary * _Nullable destinationEncryptionContext; /**

A unique identifier for the KMS key that is used to reencrypt the data. Specify a symmetric encryption KMS key or an asymmetric KMS key with a KeyUsage value of ENCRYPT_DECRYPT. To find the KeyUsage value of a KMS key, use the DescribeKey operation.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

*/ @property (nonatomic, strong) NSString * _Nullable destinationKeyId; /**

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

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

*/ @property (nonatomic, strong) NSNumber * _Nullable dryRun; /**

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

*/ @property (nonatomic, strong) NSArray * _Nullable grantTokens; /**

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

Specify the same algorithm that was used to encrypt the ciphertext. If you specify a different algorithm, the decrypt attempt fails.

This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key.

*/ @property (nonatomic, assign) AWSKMSEncryptionAlgorithmSpec sourceEncryptionAlgorithm; /**

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

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

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

*/ @property (nonatomic, strong) NSDictionary * _Nullable sourceEncryptionContext; /**

Specifies the KMS key that KMS will use to decrypt the ciphertext before it is re-encrypted.

Enter a key ID of the KMS key that was used to encrypt the ciphertext. If you identify a different KMS key, the ReEncrypt operation throws an IncorrectKeyException.

This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key. If you used a symmetric encryption KMS key, KMS can get the KMS key from metadata that it adds to the symmetric ciphertext blob. However, it is always recommended as a best practice. This practice ensures that you use the KMS key that you intend.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

*/ @property (nonatomic, strong) NSString * _Nullable sourceKeyId; @end /** */ @interface AWSKMSReEncryptResponse : AWSModel /**

The reencrypted data. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

*/ @property (nonatomic, strong) NSData * _Nullable ciphertextBlob; /**

The encryption algorithm that was used to reencrypt the data.

*/ @property (nonatomic, assign) AWSKMSEncryptionAlgorithmSpec destinationEncryptionAlgorithm; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable keyId; /**

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

*/ @property (nonatomic, assign) AWSKMSEncryptionAlgorithmSpec sourceEncryptionAlgorithm; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable sourceKeyId; @end /**

Contains information about the party that receives the response from the API operation.

This data type is designed to support Amazon Web Services Nitro Enclaves, which lets you create an isolated compute environment in Amazon EC2. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see How Amazon Web Services Nitro Enclaves uses KMS in the Key Management Service Developer Guide.

*/ @interface AWSKMSRecipientInfo : AWSModel /**

The attestation document for an Amazon Web Services Nitro Enclave. This document includes the enclave's public key.

*/ @property (nonatomic, strong) NSData * _Nullable attestationDocument; /**

The encryption algorithm that KMS should use with the public key for an Amazon Web Services Nitro Enclave to encrypt plaintext values for the response. The only valid value is RSAES_OAEP_SHA_256.

*/ @property (nonatomic, assign) AWSKMSKeyEncryptionMechanism keyEncryptionAlgorithm; @end /** */ @interface AWSKMSReplicateKeyRequest : AWSRequest /**

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

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

For more information, see Default key policy in the Key Management Service Developer Guide.

Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.

*/ @property (nonatomic, strong) NSNumber * _Nullable bypassPolicyLockoutSafetyCheck; /**

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

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

The description is not a shared property of multi-Region keys. You can specify the same description or a different description for each key in a set of related multi-Region keys. KMS does not synchronize this property.

*/ @property (nonatomic, strong) NSString * _Nullable detail; /**

Identifies the multi-Region primary key that is being replicated. To determine whether a KMS key is a multi-Region primary key, use the DescribeKey operation to check the value of the MultiRegionKeyType property.

Specify the key ID or key ARN of a multi-Region primary key.

For example:

  • Key ID: mrk-1234abcd12ab34cd56ef1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

*/ @property (nonatomic, strong) NSString * _Nullable keyId; /**

The key policy to attach to the KMS key. This parameter is optional. If you do not provide a key policy, KMS attaches the default key policy to the KMS key.

The key policy is not a shared property of multi-Region keys. You can specify the same key policy or a different key policy for each key in a set of related multi-Region keys. KMS does not synchronize this property.

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

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

  • Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal, you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services Identity and Access Management User Guide.

A key policy document can include only the following characters:

  • Printable ASCII characters from the space character (\u0020) through the end of the ASCII character range.

  • Printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF).

  • The tab (\u0009), line feed (\u000A), and carriage return (\u000D) special characters

For information about key policies, see Key policies in KMS in the Key Management Service Developer Guide. For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the Identity and Access Management User Guide.

*/ @property (nonatomic, strong) NSString * _Nullable policy; /**

The Region ID of the Amazon Web Services Region for this replica key.

Enter the Region ID, such as us-east-1 or ap-southeast-2. For a list of Amazon Web Services Regions in which KMS is supported, see KMS service endpoints in the Amazon Web Services General Reference.

HMAC KMS keys are not supported in all Amazon Web Services Regions. If you try to replicate an HMAC KMS key in an Amazon Web Services Region in which HMAC keys are not supported, the ReplicateKey operation returns an UnsupportedOperationException. For a list of Regions in which HMAC KMS keys are supported, see HMAC keys in KMS in the Key Management Service Developer Guide.

The replica must be in a different Amazon Web Services Region than its primary key and other replicas of that primary key, but in the same Amazon Web Services partition. KMS must be available in the replica Region. If the Region is not enabled by default, the Amazon Web Services account must be enabled in the Region. For information about Amazon Web Services partitions, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. For information about enabling and disabling Regions, see Enabling a Region and Disabling a Region in the Amazon Web Services General Reference.

*/ @property (nonatomic, strong) NSString * _Nullable replicaRegion; /**

Assigns one or more tags to the replica key. Use this parameter to tag the KMS key when it is created. To tag an existing KMS key, use the TagResource operation.

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

Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management Service Developer Guide.

To use this parameter, you must have kms:TagResource permission in an IAM policy.

Tags are not a shared property of multi-Region keys. You can specify the same tags or different tags for each key in a set of related multi-Region keys. KMS does not synchronize this property.

Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.

When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details, see Tagging Keys.

*/ @property (nonatomic, strong) NSArray * _Nullable tags; @end /** */ @interface AWSKMSReplicateKeyResponse : AWSModel /**

Displays details about the new replica key, including its Amazon Resource Name (key ARN) and Key states of KMS keys. It also includes the ARN and Amazon Web Services Region of its primary key and other replica keys.

*/ @property (nonatomic, strong) AWSKMSKeyMetadata * _Nullable replicaKeyMetadata; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable replicaPolicy; /**

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

*/ @property (nonatomic, strong) NSArray * _Nullable replicaTags; @end /** */ @interface AWSKMSRetireGrantRequest : AWSRequest /**

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

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

*/ @property (nonatomic, strong) NSNumber * _Nullable dryRun; /**

Identifies the grant to retire. To get the grant ID, use CreateGrant, ListGrants, or ListRetirableGrants.

  • Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

*/ @property (nonatomic, strong) NSString * _Nullable grantId; /**

Identifies the grant to be retired. You can use a grant token to identify a new grant even before it has achieved eventual consistency.

Only the CreateGrant operation returns a grant token. For details, see Grant token and Eventual consistency in the Key Management Service Developer Guide.

*/ @property (nonatomic, strong) NSString * _Nullable grantToken; /**

The key ARN KMS key associated with the grant. To find the key ARN, use the ListKeys operation.

For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab

*/ @property (nonatomic, strong) NSString * _Nullable keyId; @end /** */ @interface AWSKMSRevokeGrantRequest : AWSRequest /**

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

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

*/ @property (nonatomic, strong) NSNumber * _Nullable dryRun; /**

Identifies the grant to revoke. To get the grant ID, use CreateGrant, ListGrants, or ListRetirableGrants.

*/ @property (nonatomic, strong) NSString * _Nullable grantId; /**

A unique identifier for the KMS key associated with the grant. To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

*/ @property (nonatomic, strong) NSString * _Nullable keyId; @end /** */ @interface AWSKMSScheduleKeyDeletionRequest : AWSRequest /**

The unique identifier of the KMS key to delete.

Specify the key ID or key ARN of the KMS key.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

*/ @property (nonatomic, strong) NSString * _Nullable keyId; /**

The waiting period, specified in number of days. After the waiting period ends, KMS deletes the KMS key.

If the KMS key is a multi-Region primary key with replica keys, the waiting period begins when the last of its replica keys is deleted. Otherwise, the waiting period begins immediately.

This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30. You can use the kms:ScheduleKeyDeletionPendingWindowInDays condition key to further constrain the values that principals can specify in the PendingWindowInDays parameter.

*/ @property (nonatomic, strong) NSNumber * _Nullable pendingWindowInDays; @end /** */ @interface AWSKMSScheduleKeyDeletionResponse : AWSModel /**

The date and time after which KMS deletes the KMS key.

If the KMS key is a multi-Region primary key with replica keys, this field does not appear. The deletion date for the primary key isn't known until its last replica key is deleted.

*/ @property (nonatomic, strong) NSDate * _Nullable deletionDate; /**

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

*/ @property (nonatomic, strong) NSString * _Nullable keyId; /**

The current status of the KMS key.

For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the Key Management Service Developer Guide.

*/ @property (nonatomic, assign) AWSKMSKeyState keyState; /**

The waiting period before the KMS key is deleted.

If the KMS key is a multi-Region primary key with replicas, the waiting period begins when the last of its replica keys is deleted. Otherwise, the waiting period begins immediately.

*/ @property (nonatomic, strong) NSNumber * _Nullable pendingWindowInDays; @end /** */ @interface AWSKMSSignRequest : AWSRequest /**

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

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

*/ @property (nonatomic, strong) NSNumber * _Nullable dryRun; /**

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

*/ @property (nonatomic, strong) NSArray * _Nullable grantTokens; /**

Identifies an asymmetric KMS key. KMS uses the private key in the asymmetric KMS key to sign the message. The KeyUsage type of the KMS key must be SIGN_VERIFY. To find the KeyUsage of a KMS key, use the DescribeKey operation.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

*/ @property (nonatomic, strong) NSString * _Nullable keyId; /**

Specifies the message or message digest to sign. Messages can be 0-4096 bytes. To sign a larger message, provide a message digest.

If you provide a message digest, use the DIGEST value of MessageType to prevent the digest from being hashed again while signing.

*/ @property (nonatomic, strong) NSData * _Nullable message; /**

Tells KMS whether the value of the Message parameter should be hashed as part of the signing algorithm. Use RAW for unhashed messages; use DIGEST for message digests, which are already hashed.

When the value of MessageType is RAW, KMS uses the standard signing algorithm, which begins with a hash function. When the value is DIGEST, KMS skips the hashing step in the signing algorithm.

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

When the value of MessageTypeis DIGEST, the length of the Message value must match the length of hashed messages for the specified signing algorithm.

You can submit a message digest and omit the MessageType or specify RAW so the digest is hashed again while signing. However, this can cause verification failures when verifying with a system that assumes a single hash.

The hashing algorithm in that Sign uses is based on the SigningAlgorithm value.

  • Signing algorithms that end in SHA_256 use the SHA_256 hashing algorithm.

  • Signing algorithms that end in SHA_384 use the SHA_384 hashing algorithm.

  • Signing algorithms that end in SHA_512 use the SHA_512 hashing algorithm.

  • SM2DSA uses the SM3 hashing algorithm. For details, see Offline verification with SM2 key pairs.

*/ @property (nonatomic, assign) AWSKMSMessageType messageType; /**

Specifies the signing algorithm to use when signing the message.

Choose an algorithm that is compatible with the type and size of the specified asymmetric KMS key. When signing with RSA key pairs, RSASSA-PSS algorithms are preferred. We include RSASSA-PKCS1-v1_5 algorithms for compatibility with existing applications.

*/ @property (nonatomic, assign) AWSKMSSigningAlgorithmSpec signingAlgorithm; @end /** */ @interface AWSKMSSignResponse : AWSModel /**

The Amazon Resource Name (key ARN) of the asymmetric KMS key that was used to sign the message.

*/ @property (nonatomic, strong) NSString * _Nullable keyId; /**

The cryptographic signature that was generated for the message.

  • When used with the supported RSA signing algorithms, the encoding of this value is defined by PKCS #1 in RFC 8017.

  • When used with the ECDSA_SHA_256, ECDSA_SHA_384, or ECDSA_SHA_512 signing algorithms, this value is a DER-encoded object as defined by ANSI X9.62–2005 and RFC 3279 Section 2.2.3. This is the most commonly used signature format and is appropriate for most uses.

When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

*/ @property (nonatomic, strong) NSData * _Nullable signature; /**

The signing algorithm that was used to sign the message.

*/ @property (nonatomic, assign) AWSKMSSigningAlgorithmSpec signingAlgorithm; @end /**

A key-value pair. A 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.

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

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

Required parameters: [TagKey, TagValue] */ @interface AWSKMSTag : AWSModel /**

The key of the tag.

*/ @property (nonatomic, strong) NSString * _Nullable tagKey; /**

The value of the tag.

*/ @property (nonatomic, strong) NSString * _Nullable tagValue; @end /** */ @interface AWSKMSTagResourceRequest : AWSRequest /**

Identifies a customer managed key in the account and Region.

Specify the key ID or key ARN of the KMS key.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

*/ @property (nonatomic, strong) NSString * _Nullable keyId; /**

One or more tags. Each tag consists of a tag key and a tag value. The tag value can be an empty (null) string.

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

You cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.

*/ @property (nonatomic, strong) NSArray * _Nullable tags; @end /** */ @interface AWSKMSUntagResourceRequest : AWSRequest /**

Identifies the KMS key from which you are removing tags.

Specify the key ID or key ARN of the KMS key.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

*/ @property (nonatomic, strong) NSString * _Nullable keyId; /**

One or more tag keys. Specify only the tag keys, not the tag values.

*/ @property (nonatomic, strong) NSArray * _Nullable tagKeys; @end /** */ @interface AWSKMSUpdateAliasRequest : AWSRequest /**

Identifies the alias that is changing its KMS key. This value must begin with alias/ followed by the alias name, such as alias/ExampleAlias. You cannot use UpdateAlias to change the alias name.

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

 */ @property (nonatomic, strong) NSString * _Nullable aliasName; /**

Identifies the customer managed key to associate with the alias. You don't have permission to associate an alias with an Amazon Web Services managed key.

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

Specify the key ID or key ARN of the KMS key.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

To verify that the alias is mapped to the correct KMS key, use ListAliases.

*/ @property (nonatomic, strong) NSString * _Nullable targetKeyId; @end /** */ @interface AWSKMSUpdateCustomKeyStoreRequest : AWSRequest /**

Associates the custom key store with a related CloudHSM cluster. This parameter is valid only for custom key stores with a CustomKeyStoreType of AWS_CLOUDHSM.

Enter the cluster ID of the cluster that you used to create the custom key store or a cluster that shares a backup history and has the same cluster certificate as the original cluster. You cannot use this parameter to associate a custom key store with an unrelated cluster. In addition, the replacement cluster must fulfill the requirements for a cluster associated with a custom key store. To view the cluster certificate of a cluster, use the DescribeClusters operation.

To change this value, the CloudHSM key store must be disconnected.

*/ @property (nonatomic, strong) NSString * _Nullable cloudHsmClusterId; /**

Identifies the custom key store that you want to update. Enter the ID of the custom key store. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

*/ @property (nonatomic, strong) NSString * _Nullable customKeyStoreId; /**

Enter the current password of the kmsuser crypto user (CU) in the CloudHSM cluster that is associated with the custom key store. This parameter is valid only for custom key stores with a CustomKeyStoreType of AWS_CLOUDHSM.

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

To change this value, the CloudHSM key store must be disconnected.

*/ @property (nonatomic, strong) NSString * _Nullable keyStorePassword; /**

Changes the friendly name of the custom key store to the value that you specify. The custom key store name must be unique in the Amazon Web Services account.

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

To change this value, an CloudHSM key store must be disconnected. An external key store can be connected or disconnected.

*/ @property (nonatomic, strong) NSString * _Nullable latestCustomKeyStoreName; /**

Changes the credentials that KMS uses to sign requests to the external key store proxy (XKS proxy). This parameter is valid only for custom key stores with a CustomKeyStoreType of EXTERNAL_KEY_STORE.

You must specify both the AccessKeyId and SecretAccessKey value in the authentication credential, even if you are only updating one value.

This parameter doesn't establish or change your authentication credentials on the proxy. It just tells KMS the credential that you established with your external key store proxy. For example, if you rotate the credential on your external key store proxy, you can use this parameter to update the credential in KMS.

You can change this value when the external key store is connected or disconnected.

*/ @property (nonatomic, strong) AWSKMSXksProxyAuthenticationCredentialType * _Nullable xksProxyAuthenticationCredential; /**

Changes the connectivity setting for the external key store. To indicate that the external key store proxy uses a Amazon VPC endpoint service to communicate with KMS, specify VPC_ENDPOINT_SERVICE. Otherwise, specify PUBLIC_ENDPOINT.

If you change the XksProxyConnectivity to VPC_ENDPOINT_SERVICE, you must also change the XksProxyUriEndpoint and add an XksProxyVpcEndpointServiceName value.

If you change the XksProxyConnectivity to PUBLIC_ENDPOINT, you must also change the XksProxyUriEndpoint and specify a null or empty string for the XksProxyVpcEndpointServiceName value.

To change this value, the external key store must be disconnected.

*/ @property (nonatomic, assign) AWSKMSXksProxyConnectivityType xksProxyConnectivity; /**

Changes the URI endpoint that KMS uses to connect to your external key store proxy (XKS proxy). This parameter is valid only for custom key stores with a CustomKeyStoreType of EXTERNAL_KEY_STORE.

For external key stores with an XksProxyConnectivity value of PUBLIC_ENDPOINT, the protocol must be HTTPS.

For external key stores with an XksProxyConnectivity value of VPC_ENDPOINT_SERVICE, specify https:// followed by the private DNS name associated with the VPC endpoint service. Each external key store must use a different private DNS name.

The combined XksProxyUriEndpoint and XksProxyUriPath values must be unique in the Amazon Web Services account and Region.

To change this value, the external key store must be disconnected.

*/ @property (nonatomic, strong) NSString * _Nullable xksProxyUriEndpoint; /**

Changes the base path to the proxy APIs for this external key store. To find this value, see the documentation for your external key manager and external key store proxy (XKS proxy). This parameter is valid only for custom key stores with a CustomKeyStoreType of EXTERNAL_KEY_STORE.

The value must start with / and must end with /kms/xks/v1, where v1 represents the version of the KMS external key store proxy API. You can include an optional prefix between the required elements such as /example/kms/xks/v1.

The combined XksProxyUriEndpoint and XksProxyUriPath values must be unique in the Amazon Web Services account and Region.

You can change this value when the external key store is connected or disconnected.

*/ @property (nonatomic, strong) NSString * _Nullable xksProxyUriPath; /**

Changes the name that KMS uses to identify the Amazon VPC endpoint service for your external key store proxy (XKS proxy). This parameter is valid when the CustomKeyStoreType is EXTERNAL_KEY_STORE and the XksProxyConnectivity is VPC_ENDPOINT_SERVICE.

To change this value, the external key store must be disconnected.

*/ @property (nonatomic, strong) NSString * _Nullable xksProxyVpcEndpointServiceName; @end /** */ @interface AWSKMSUpdateCustomKeyStoreResponse : AWSModel @end /** */ @interface AWSKMSUpdateKeyDescriptionRequest : AWSRequest /**

New description for the KMS key.

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

 */ @property (nonatomic, strong) NSString * _Nullable detail; /**

Updates the description of the specified KMS key.

Specify the key ID or key ARN of the KMS key.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

*/ @property (nonatomic, strong) NSString * _Nullable keyId; @end /** */ @interface AWSKMSUpdatePrimaryRegionRequest : AWSRequest /**

Identifies the current primary key. When the operation completes, this KMS key will be a replica key.

Specify the key ID or key ARN of a multi-Region primary key.

For example:

  • Key ID: mrk-1234abcd12ab34cd56ef1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

*/ @property (nonatomic, strong) NSString * _Nullable keyId; /**

The Amazon Web Services Region of the new primary key. Enter the Region ID, such as us-east-1 or ap-southeast-2. There must be an existing replica key in this Region.

When the operation completes, the multi-Region key in this Region will be the primary key.

*/ @property (nonatomic, strong) NSString * _Nullable primaryRegion; @end /** */ @interface AWSKMSVerifyMacRequest : AWSRequest /**

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

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

*/ @property (nonatomic, strong) NSNumber * _Nullable dryRun; /**

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

*/ @property (nonatomic, strong) NSArray * _Nullable grantTokens; /**

The KMS key that will be used in the verification.

Enter a key ID of the KMS key that was used to generate the HMAC. If you identify a different KMS key, the VerifyMac operation fails.

*/ @property (nonatomic, strong) NSString * _Nullable keyId; /**

The HMAC to verify. Enter the HMAC that was generated by the GenerateMac operation when you specified the same message, HMAC KMS key, and MAC algorithm as the values specified in this request.

*/ @property (nonatomic, strong) NSData * _Nullable mac; /**

The MAC algorithm that will be used in the verification. Enter the same MAC algorithm that was used to compute the HMAC. This algorithm must be supported by the HMAC KMS key identified by the KeyId parameter.

*/ @property (nonatomic, assign) AWSKMSMacAlgorithmSpec macAlgorithm; /**

The message that will be used in the verification. Enter the same message that was used to generate the HMAC.

GenerateMac and VerifyMac do not provide special handling for message digests. If you generated an HMAC for a hash digest of a message, you must verify the HMAC for the same hash digest.

*/ @property (nonatomic, strong) NSData * _Nullable message; @end /** */ @interface AWSKMSVerifyMacResponse : AWSModel /**

The HMAC KMS key used in the verification.

*/ @property (nonatomic, strong) NSString * _Nullable keyId; /**

The MAC algorithm used in the verification.

*/ @property (nonatomic, assign) AWSKMSMacAlgorithmSpec macAlgorithm; /**

A Boolean value that indicates whether the HMAC was verified. A value of True indicates that the HMAC (Mac) was generated with the specified Message, HMAC KMS key (KeyID) and MacAlgorithm..

If the HMAC is not verified, the VerifyMac operation fails with a KMSInvalidMacException exception. This exception indicates that one or more of the inputs changed since the HMAC was computed.

*/ @property (nonatomic, strong) NSNumber * _Nullable macValid; @end /** */ @interface AWSKMSVerifyRequest : AWSRequest /**

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

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

*/ @property (nonatomic, strong) NSNumber * _Nullable dryRun; /**

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

*/ @property (nonatomic, strong) NSArray * _Nullable grantTokens; /**

Identifies the asymmetric KMS key that will be used to verify the signature. This must be the same KMS key that was used to generate the signature. If you specify a different KMS key, the signature verification fails.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

*/ @property (nonatomic, strong) NSString * _Nullable keyId; /**

Specifies the message that was signed. You can submit a raw message of up to 4096 bytes, or a hash digest of the message. If you submit a digest, use the MessageType parameter with a value of DIGEST.

If the message specified here is different from the message that was signed, the signature verification fails. A message and its hash digest are considered to be the same message.

*/ @property (nonatomic, strong) NSData * _Nullable message; /**

Tells KMS whether the value of the Message parameter should be hashed as part of the signing algorithm. Use RAW for unhashed messages; use DIGEST for message digests, which are already hashed.

When the value of MessageType is RAW, KMS uses the standard signing algorithm, which begins with a hash function. When the value is DIGEST, KMS skips the hashing step in the signing algorithm.

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

When the value of MessageTypeis DIGEST, the length of the Message value must match the length of hashed messages for the specified signing algorithm.

You can submit a message digest and omit the MessageType or specify RAW so the digest is hashed again while signing. However, if the signed message is hashed once while signing, but twice while verifying, verification fails, even when the message hasn't changed.

The hashing algorithm in that Verify uses is based on the SigningAlgorithm value.

  • Signing algorithms that end in SHA_256 use the SHA_256 hashing algorithm.

  • Signing algorithms that end in SHA_384 use the SHA_384 hashing algorithm.

  • Signing algorithms that end in SHA_512 use the SHA_512 hashing algorithm.

  • SM2DSA uses the SM3 hashing algorithm. For details, see Offline verification with SM2 key pairs.

*/ @property (nonatomic, assign) AWSKMSMessageType messageType; /**

The signature that the Sign operation generated.

*/ @property (nonatomic, strong) NSData * _Nullable signature; /**

The signing algorithm that was used to sign the message. If you submit a different algorithm, the signature verification fails.

*/ @property (nonatomic, assign) AWSKMSSigningAlgorithmSpec signingAlgorithm; @end /** */ @interface AWSKMSVerifyResponse : AWSModel /**

The Amazon Resource Name (key ARN) of the asymmetric KMS key that was used to verify the signature.

*/ @property (nonatomic, strong) NSString * _Nullable keyId; /**

A Boolean value that indicates whether the signature was verified. A value of True indicates that the Signature was produced by signing the Message with the specified KeyID and SigningAlgorithm. If the signature is not verified, the Verify operation fails with a KMSInvalidSignatureException exception.

*/ @property (nonatomic, strong) NSNumber * _Nullable signatureValid; /**

The signing algorithm that was used to verify the signature.

*/ @property (nonatomic, assign) AWSKMSSigningAlgorithmSpec signingAlgorithm; @end /**

Information about the external key that is associated with a KMS key in an external key store.

This element appears in a CreateKey or DescribeKey response only for a KMS key in an external key store.

The external key is a symmetric encryption key that is hosted by an external key manager outside of Amazon Web Services. When you use the KMS key in an external key store in a cryptographic operation, the cryptographic operation is performed in the external key manager using the specified external key. For more information, see External key in the Key Management Service Developer Guide.

*/ @interface AWSKMSXksKeyConfigurationType : AWSModel /**

The ID of the external key in its external key manager. This is the ID that the external key store proxy uses to identify the external key.

*/ @property (nonatomic, strong) NSString * _Nullable identifier; @end /**

KMS uses the authentication credential to sign requests that it sends to the external key store proxy (XKS proxy) on your behalf. You establish these credentials on your external key store proxy and report them to KMS.

The XksProxyAuthenticationCredential includes two required elements.

Required parameters: [AccessKeyId, RawSecretAccessKey] */ @interface AWSKMSXksProxyAuthenticationCredentialType : AWSModel /**

A unique identifier for the raw secret access key.

*/ @property (nonatomic, strong) NSString * _Nullable accessKeyId; /**

A secret string of 43-64 characters. Valid characters are a-z, A-Z, 0-9, /, +, and =.

*/ @property (nonatomic, strong) NSString * _Nullable rawSecretAccessKey; @end /**

Detailed information about the external key store proxy (XKS proxy). Your external key store proxy translates KMS requests into a format that your external key manager can understand. These fields appear in a DescribeCustomKeyStores response only when the CustomKeyStoreType is EXTERNAL_KEY_STORE.

*/ @interface AWSKMSXksProxyConfigurationType : AWSModel /**

The part of the external key store proxy authentication credential that uniquely identifies the secret access key.

*/ @property (nonatomic, strong) NSString * _Nullable accessKeyId; /**

Indicates whether the external key store proxy uses a public endpoint or an Amazon VPC endpoint service to communicate with KMS.

*/ @property (nonatomic, assign) AWSKMSXksProxyConnectivityType connectivity; /**

The URI endpoint for the external key store proxy.

If the external key store proxy has a public endpoint, it is displayed here.

If the external key store proxy uses an Amazon VPC endpoint service name, this field displays the private DNS name associated with the VPC endpoint service.

*/ @property (nonatomic, strong) NSString * _Nullable uriEndpoint; /**

The path to the external key store proxy APIs.

*/ @property (nonatomic, strong) NSString * _Nullable uriPath; /**

The Amazon VPC endpoint service used to communicate with the external key store proxy. This field appears only when the external key store proxy uses an Amazon VPC endpoint service to communicate with KMS.

*/ @property (nonatomic, strong) NSString * _Nullable vpcEndpointServiceName; @end NS_ASSUME_NONNULL_END