Struct DeriveSharedSecretOutput

#[non_exhaustive]
pub struct DeriveSharedSecretOutput {
    pub key_id: Option<String>,
    pub shared_secret: Option<Blob>,
    pub ciphertext_for_recipient: Option<Blob>,
    pub key_agreement_algorithm: Option<KeyAgreementAlgorithmSpec>,
    pub key_origin: Option<OriginType>,
    /* 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>

Identifies the KMS key used to derive the shared secret.

shared_secret: Option<Blob>

The raw secret derived from the specified key agreement algorithm, private key in the asymmetric KMS key, and your peer's public key.

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

ciphertext_for_recipient: Option<Blob>

The plaintext shared secret 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.

key_agreement_algorithm: Option<KeyAgreementAlgorithmSpec>

Identifies the key agreement algorithm used to derive the shared secret.

key_origin: Option<OriginType>

The source of the key material for the specified 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.

The only valid values for DeriveSharedSecret are AWS_KMS and EXTERNAL. DeriveSharedSecret does not support KMS keys with a KeyOrigin value of AWS_CLOUDHSM or EXTERNAL_KEY_STORE.

Implementations

impl DeriveSharedSecretOutput

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

Identifies the KMS key used to derive the shared secret.

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

The raw secret derived from the specified key agreement algorithm, private key in the asymmetric KMS key, and your peer's public key.

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

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

The plaintext shared secret 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.

pub fn key_agreement_algorithm(&self) -> Option<&KeyAgreementAlgorithmSpec>

Identifies the key agreement algorithm used to derive the shared secret.

pub fn key_origin(&self) -> Option<&OriginType>

The source of the key material for the specified 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.

The only valid values for DeriveSharedSecret are AWS_KMS and EXTERNAL. DeriveSharedSecret does not support KMS keys with a KeyOrigin value of AWS_CLOUDHSM or EXTERNAL_KEY_STORE.

impl DeriveSharedSecretOutput

pub fn builder() -> DeriveSharedSecretOutputBuilder

Creates a new builder-style object to manufacture DeriveSharedSecretOutput.

Trait Implementations

impl Clone for DeriveSharedSecretOutput

fn clone(&self) -> DeriveSharedSecretOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DeriveSharedSecretOutput

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

Formats the value using the given formatter.

impl PartialEq for DeriveSharedSecretOutput

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for DeriveSharedSecretOutput

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

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

impl StructuralPartialEq for DeriveSharedSecretOutput