Class DeriveSharedSecretResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.kms.model.KmsResponse
software.amazon.awssdk.services.kms.model.DeriveSharedSecretResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DeriveSharedSecretResponse.Builder,DeriveSharedSecretResponse>
@Generated("software.amazon.awssdk:codegen") public final class DeriveSharedSecretResponse extends KmsResponse implements ToCopyableBuilder<DeriveSharedSecretResponse.Builder,DeriveSharedSecretResponse>

  • Method Details

    • keyId

      public final String keyId()

      Identifies the KMS key used to derive the shared secret.

      Returns:
      Identifies the KMS key used to derive the shared secret.

    • sharedSecret

      public final SdkBytes sharedSecret()

      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.

      Returns:
      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.

    • ciphertextForRecipient

      public final SdkBytes ciphertextForRecipient()

      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.

      Returns:
      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.

    • keyAgreementAlgorithm

      public final KeyAgreementAlgorithmSpec keyAgreementAlgorithm()

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

      If the service returns an enum value that is not available in the current SDK version, keyAgreementAlgorithm will return KeyAgreementAlgorithmSpec.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyAgreementAlgorithmAsString().

      Returns:
      Identifies the key agreement algorithm used to derive the shared secret.
      See Also:

    • keyAgreementAlgorithmAsString

      public final String keyAgreementAlgorithmAsString()

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

      If the service returns an enum value that is not available in the current SDK version, keyAgreementAlgorithm will return KeyAgreementAlgorithmSpec.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyAgreementAlgorithmAsString().

      Returns:
      Identifies the key agreement algorithm used to derive the shared secret.
      See Also:

    • keyOrigin

      public final OriginType keyOrigin()

      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.

      If the service returns an enum value that is not available in the current SDK version, keyOrigin will return OriginType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyOriginAsString().

      Returns:
      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.

      See Also:

    • keyOriginAsString

      public final String keyOriginAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, keyOrigin will return OriginType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyOriginAsString().

      Returns:
      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.

      See Also:

    • toBuilder

      public DeriveSharedSecretResponse.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DeriveSharedSecretResponse.Builder,DeriveSharedSecretResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DeriveSharedSecretResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DeriveSharedSecretResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.