Package software.amazon.awssdk.services.kms.model

Class SignResponse

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.SignResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<SignResponse.Builder,SignResponse>
@Generated("software.amazon.awssdk:codegen") public final class SignResponse extends KmsResponse implements ToCopyableBuilder<SignResponse.Builder,SignResponse>

  • Method Details

    • keyId

      public final String keyId()

      The Amazon Resource Name (key ARN) of the asymmetric KMS key that was used to sign the message.

      Returns:
      The Amazon Resource Name (key ARN) of the asymmetric KMS key that was used to sign the message.

    • signature

      public final SdkBytes signature()

      The cryptographic signature that was generated for the message.

      • When used with the supported RSA signing algorithms, the encoding of this value is defined by PKCS #1 in RFC 8017.

      • When used with the ECDSA_SHA_256, ECDSA_SHA_384, or ECDSA_SHA_512 signing algorithms, this value is a DER-encoded object as defined by ANSI X9.62–2005 and RFC 3279 Section 2.2.3. This is the most commonly used signature format and is appropriate for most uses.

      When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

      Returns:
      The cryptographic signature that was generated for the message.

      • When used with the supported RSA signing algorithms, the encoding of this value is defined by PKCS #1 in RFC 8017.

      • When used with the ECDSA_SHA_256, ECDSA_SHA_384, or ECDSA_SHA_512 signing algorithms, this value is a DER-encoded object as defined by ANSI X9.62–2005 and RFC 3279 Section 2.2.3. This is the most commonly used signature format and is appropriate for most uses.

      When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

    • signingAlgorithm

      public final SigningAlgorithmSpec signingAlgorithm()

      The signing algorithm that was used to sign the message.

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

      Returns:
      The signing algorithm that was used to sign the message.
      See Also:

    • signingAlgorithmAsString

      public final String signingAlgorithmAsString()

      The signing algorithm that was used to sign the message.

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

      Returns:
      The signing algorithm that was used to sign the message.
      See Also:

    • toBuilder

      public SignResponse.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<SignResponse.Builder,SignResponse>
      Specified by:
      toBuilder in class AwsResponse

    • builder

      public static SignResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SignResponse.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