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>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DeriveSharedSecretResponse.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static DeriveSharedSecretResponse.Builder`	`builder()`
`SdkBytes`	`ciphertextForRecipient()`	The plaintext shared secret encrypted with the public key from the attestation document.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`KeyAgreementAlgorithmSpec`	`keyAgreementAlgorithm()`	Identifies the key agreement algorithm used to derive the shared secret.
`String`	`keyAgreementAlgorithmAsString()`	Identifies the key agreement algorithm used to derive the shared secret.
`String`	`keyId()`	Identifies the KMS key used to derive the shared secret.
`OriginType`	`keyOrigin()`	The source of the key material for the specified KMS key.
`String`	`keyOriginAsString()`	The source of the key material for the specified KMS key.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DeriveSharedSecretResponse.Builder>`	`serializableBuilderClass()`
`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.
`DeriveSharedSecretResponse.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.kms.model.KmsResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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 from the attestation document. This ciphertext can be decrypted only by using a private key from the attested environment.
    
    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 or NitroTPM. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see Cryptographic attestation support in KMS in the Key Management Service Developer Guide.
    
    Returns:
    
    The plaintext shared secret encrypted with the public key from the attestation document. This ciphertext can be decrypted only by using a private key from the attested environment.
    
    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 or NitroTPM. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see Cryptographic attestation support in 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:
    
    KeyAgreementAlgorithmSpec
  - 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:
    
    KeyAgreementAlgorithmSpec
  - 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:
    
    OriginType
  - 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:
    
    OriginType
  - toBuilder
```
public DeriveSharedSecretResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DeriveSharedSecretResponse.Builder,DeriveSharedSecretResponse>
    
    Specified by:
    
    toBuilder in class AwsResponse
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class DeriveSharedSecretResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.kms.model.KmsResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

keyId

sharedSecret

ciphertextForRecipient

keyAgreementAlgorithm

keyAgreementAlgorithmAsString

keyOrigin

keyOriginAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField