Struct GetPublicKeyOutput

#[non_exhaustive]
pub struct GetPublicKeyOutput {
    pub key_id: Option<String>,
    pub public_key: Option<Blob>,
    pub customer_master_key_spec: Option<CustomerMasterKeySpec>,
    pub key_spec: Option<KeySpec>,
    pub key_usage: Option<KeyUsageType>,
    pub encryption_algorithms: Option<Vec<EncryptionAlgorithmSpec>>,
    pub signing_algorithms: Option<Vec<SigningAlgorithmSpec>>,
    pub key_agreement_algorithms: Option<Vec<KeyAgreementAlgorithmSpec>>,
    /* 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 Amazon Resource Name (key ARN) of the asymmetric KMS key from which the public key was downloaded.

public_key: Option<Blob>

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.

customer_master_key_spec: Option<CustomerMasterKeySpec>

👎Deprecated: This field has been deprecated. Instead, use the KeySpec field.

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.

key_spec: Option<KeySpec>

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

key_usage: Option<KeyUsageType>

The permitted use of the public key. Valid values for asymmetric key pairs are ENCRYPT_DECRYPT, SIGN_VERIFY, and KEY_AGREEMENT.

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

encryption_algorithms: Option<Vec<EncryptionAlgorithmSpec>>

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.

signing_algorithms: Option<Vec<SigningAlgorithmSpec>>

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.

key_agreement_algorithms: Option<Vec<KeyAgreementAlgorithmSpec>>

The key agreement algorithm used to derive a shared secret. This field is present only when the KMS key has a KeyUsage value of KEY_AGREEMENT.

Implementations

impl GetPublicKeyOutput

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

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

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

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.

pub fn customer_master_key_spec(&self) -> Option<&CustomerMasterKeySpec>

👎Deprecated: This field has been deprecated. Instead, use the KeySpec field.

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.

pub fn key_spec(&self) -> Option<&KeySpec>

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

pub fn key_usage(&self) -> Option<&KeyUsageType>

The permitted use of the public key. Valid values for asymmetric key pairs are ENCRYPT_DECRYPT, SIGN_VERIFY, and KEY_AGREEMENT.

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

pub fn encryption_algorithms(&self) -> &[EncryptionAlgorithmSpec]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .encryption_algorithms.is_none().

pub fn signing_algorithms(&self) -> &[SigningAlgorithmSpec]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .signing_algorithms.is_none().

pub fn key_agreement_algorithms(&self) -> &[KeyAgreementAlgorithmSpec]

The key agreement algorithm used to derive a shared secret. This field is present only when the KMS key has a KeyUsage value of KEY_AGREEMENT.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .key_agreement_algorithms.is_none().

impl GetPublicKeyOutput

pub fn builder() -> GetPublicKeyOutputBuilder

Creates a new builder-style object to manufacture GetPublicKeyOutput.

Trait Implementations

impl Clone for GetPublicKeyOutput

fn clone(&self) -> GetPublicKeyOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetPublicKeyOutput

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

Formats the value using the given formatter.

impl PartialEq for GetPublicKeyOutput

fn eq(&self, other: &GetPublicKeyOutput) -> 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 GetPublicKeyOutput

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

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

impl StructuralPartialEq for GetPublicKeyOutput