Struct EncapsulateOutput 

#[non_exhaustive]
pub struct EncapsulateOutput {
    pub key_id: Option<String>,
    pub shared_secret: Option<Blob>,
    pub shared_secret_ciphertext_blob: Option<Blob>,
    pub encapsulation_algorithm: Option<EncapsulationAlgorithmSpec>,
    /* private fields */
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

key_id: Option<String>

The identifier of the ML-KEM KMS key used to encapsulate the shared secret.

shared_secret: Option<Blob>

The plaintext shared secret. It is a 32-byte cryptographically random value that both parties can use directly as key material or pass through a key derivation function to generate multiple keys and nonces. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

shared_secret_ciphertext_blob: Option<Blob>

The encapsulated form of the shared secret. Pass this value to the Decapsulate operation to recover the shared secret. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded. The length of SharedSecretCiphertextBlob depends on the ML-KEM key spec. Before Base64 encoding, the encapsulated shared secret is 768 bytes for ML_KEM_512, 1088 bytes for ML_KEM_768, and 1568 bytes for ML_KEM_1024.

encapsulation_algorithm: Option<EncapsulationAlgorithmSpec>

The key encapsulation algorithm used to generate the shared secret.

Implementations

impl EncapsulateOutput

pub fn key_id(&self) -> Option<&str>

The identifier of the ML-KEM KMS key used to encapsulate the shared secret.

pub fn shared_secret(&self) -> Option<&Blob>

The plaintext shared secret. It is a 32-byte cryptographically random value that both parties can use directly as key material or pass through a key derivation function to generate multiple keys and nonces. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

pub fn shared_secret_ciphertext_blob(&self) -> Option<&Blob>

The encapsulated form of the shared secret. Pass this value to the Decapsulate operation to recover the shared secret. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded. The length of SharedSecretCiphertextBlob depends on the ML-KEM key spec. Before Base64 encoding, the encapsulated shared secret is 768 bytes for ML_KEM_512, 1088 bytes for ML_KEM_768, and 1568 bytes for ML_KEM_1024.

pub fn encapsulation_algorithm(&self) -> Option<&EncapsulationAlgorithmSpec>

The key encapsulation algorithm used to generate the shared secret.

impl EncapsulateOutput

pub fn builder() -> EncapsulateOutputBuilder

Creates a new builder-style object to manufacture EncapsulateOutput.

Trait Implementations

impl Clone for EncapsulateOutput

fn clone(&self) -> EncapsulateOutput

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EncapsulateOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for EncapsulateOutput

fn eq(&self, other: &EncapsulateOutput) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl RequestId for EncapsulateOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for EncapsulateOutput