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 be ENCRYPT_DECRYPT. For signing and verifying messages, the KeyUsage must be SIGN_VERIFY. For generating and verifying message authentication codes (MACs), the KeyUsage must be GENERATE_VERIFY_MAC. For deriving key agreement secrets, the KeyUsage must be KEY_AGREEMENT. To find the KeyUsage 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

Modifier and Type	Method	Description
static InvalidKeyUsageException.Builder	builder()
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends InvalidKeyUsageException.Builder>	serializableBuilderClass()
InvalidKeyUsageException.Builder	toBuilder()	Create a AwsServiceException.Builder initialized with the properties of this AwsServiceException.

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, isRetryableException, requestId, statusCode

Methods inherited from class software.amazon.awssdk.core.exception.SdkException

create, numAttempts, rawMessage, 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

equals, 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 Details

toBuilder

public InvalidKeyUsageException.Builder toBuilder()

Description copied from class: AwsServiceException

Create a AwsServiceException.Builder initialized with the properties of this AwsServiceException.

Specified by:

toBuilder in interface ToCopyableBuilder<InvalidKeyUsageException.Builder,InvalidKeyUsageException>

Overrides:

toBuilder in class KmsException

Returns:

A new builder initialized with this config's properties.

builder

public static InvalidKeyUsageException.Builder builder()

serializableBuilderClass

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

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Overrides:

sdkFields in class SdkServiceException

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.