AWSKMSGenerateDataKeyPairResponse

Objective-C

@interface AWSKMSGenerateDataKeyPairResponse

Swift

class AWSKMSGenerateDataKeyPairResponse

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

    Declaration

    Objective-C

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

    Swift

    var ciphertextForRecipient: Data? { get set }

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

    Declaration

    Objective-C

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

    Swift

    var keyId: String? { get set }

  • The type of data key pair that was generated.

    Declaration

    Objective-C

    @property (nonatomic) AWSKMSDataKeyPairSpec keyPairSpec;

    Swift

    var keyPairSpec: AWSKMSDataKeyPairSpec { get set }

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

    Declaration

    Objective-C

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

    Swift

    var privateKeyCiphertextBlob: Data? { get set }

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

    Declaration

    Objective-C

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

    Swift

    var privateKeyPlaintext: Data? { get set }

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

    Declaration

    Objective-C

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

    Swift

    var publicKey: Data? { get set }