software.amazon.awssdk.services.kms.model.InvalidKeyUsageException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kms Show documentation
The AWS Java SDK for AWS KMS module holds the client classes that are used for communicating with AWS Key Management Service
There is a newer version: 2.29.39
Show newest version
/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
 * the License. A copy of the License is located at
 * 
 * http://aws.amazon.com/apache2.0
 * 
 * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
 * and limitations under the License.
 */

package software.amazon.awssdk.services.kms.model;

import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.exception.AwsErrorDetails;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;

/**
 * 
 * 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. 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.
 * 
 */
@Generated("software.amazon.awssdk:codegen")
public final class InvalidKeyUsageException extends KmsException implements
        ToCopyableBuilder {
    private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList());

    private static final long serialVersionUID = 1L;

    private InvalidKeyUsageException(BuilderImpl builder) {
        super(builder);
    }

    @Override
    public Builder toBuilder() {
        return new BuilderImpl(this);
    }

    public static Builder builder() {
        return new BuilderImpl();
    }

    public static Class serializableBuilderClass() {
        return BuilderImpl.class;
    }

    @Override
    public final List> sdkFields() {
        return SDK_FIELDS;
    }

    public interface Builder extends SdkPojo, CopyableBuilder, KmsException.Builder {
        @Override
        Builder awsErrorDetails(AwsErrorDetails awsErrorDetails);

        @Override
        Builder message(String message);

        @Override
        Builder requestId(String requestId);

        @Override
        Builder statusCode(int statusCode);

        @Override
        Builder cause(Throwable cause);

        @Override
        Builder writableStackTrace(Boolean writableStackTrace);
    }

    static final class BuilderImpl extends KmsException.BuilderImpl implements Builder {
        private BuilderImpl() {
        }

        private BuilderImpl(InvalidKeyUsageException model) {
            super(model);
        }

        @Override
        public BuilderImpl awsErrorDetails(AwsErrorDetails awsErrorDetails) {
            this.awsErrorDetails = awsErrorDetails;
            return this;
        }

        @Override
        public BuilderImpl message(String message) {
            this.message = message;
            return this;
        }

        @Override
        public BuilderImpl requestId(String requestId) {
            this.requestId = requestId;
            return this;
        }

        @Override
        public BuilderImpl statusCode(int statusCode) {
            this.statusCode = statusCode;
            return this;
        }

        @Override
        public BuilderImpl cause(Throwable cause) {
            this.cause = cause;
            return this;
        }

        @Override
        public BuilderImpl writableStackTrace(Boolean writableStackTrace) {
            this.writableStackTrace = writableStackTrace;
            return this;
        }

        @Override
        public InvalidKeyUsageException build() {
            return new InvalidKeyUsageException(this);
        }

        @Override
        public List> sdkFields() {
            return SDK_FIELDS;
        }
    }
}