Class InvalidKeyUsageException
- java.lang.Object
-
- java.lang.Throwable
-
- java.lang.Exception
-
- java.lang.RuntimeException
-
- software.amazon.awssdk.core.exception.SdkException
-
- software.amazon.awssdk.core.exception.SdkServiceException
-
- software.amazon.awssdk.awscore.exception.AwsServiceException
-
- software.amazon.awssdk.services.kms.model.KmsException
-
- software.amazon.awssdk.services.kms.model.InvalidKeyUsageException
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<InvalidKeyUsageException.Builder,InvalidKeyUsageException>
@Generated("software.amazon.awssdk:codegen") public final class InvalidKeyUsageException extends KmsException implements ToCopyableBuilder<InvalidKeyUsageException.Builder,InvalidKeyUsageException>
The request was rejected for one of the following reasons:
-
The
KeyUsage
value of the KMS key is incompatible with the API operation. -
The encryption algorithm or signing algorithm specified for the operation is incompatible with the type of key material in the KMS key
(KeySpec
).
For encrypting, decrypting, re-encrypting, and generating data keys, the
KeyUsage
must beENCRYPT_DECRYPT
. For signing and verifying messages, theKeyUsage
must beSIGN_VERIFY
. For generating and verifying message authentication codes (MACs), theKeyUsage
must beGENERATE_VERIFY_MAC
. To find theKeyUsage
of a KMS key, use the DescribeKey operation.To find the encryption or signing algorithms supported for a particular KMS key, use the DescribeKey operation.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
InvalidKeyUsageException.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static InvalidKeyUsageException.Builder
builder()
List<SdkField<?>>
sdkFields()
static Class<? extends InvalidKeyUsageException.Builder>
serializableBuilderClass()
InvalidKeyUsageException.Builder
toBuilder()
-
Methods inherited from class software.amazon.awssdk.awscore.exception.AwsServiceException
awsErrorDetails, getMessage, isClockSkewException, isThrottlingException
-
Methods inherited from class software.amazon.awssdk.core.exception.SdkServiceException
extendedRequestId, requestId, statusCode
-
Methods inherited from class software.amazon.awssdk.core.exception.SdkException
create, retryable
-
Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
toBuilder
public InvalidKeyUsageException.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<InvalidKeyUsageException.Builder,InvalidKeyUsageException>
- Overrides:
toBuilder
in classKmsException
-
builder
public static InvalidKeyUsageException.Builder builder()
-
serializableBuilderClass
public static Class<? extends InvalidKeyUsageException.Builder> serializableBuilderClass()
-
-