...
AWS SDK for Go API Reference
import "github.com/aws/aws-sdk-go/service/kms"
Overview
Examples
Constants

Overview ▾

Package kms provides the client and types for making API requests to AWS Key Management Service.

AWS Key Management Service (AWS KMS) is an encryption and key management web service. This guide describes the AWS KMS operations that you can call programmatically. For general information about AWS KMS, see the AWS Key Management Service Developer Guide (https://docs.aws.amazon.com/kms/latest/developerguide/).

AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, macOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWS KMS and other AWS services. For example, the SDKs take care of tasks such as signing requests (see below), managing errors, and retrying requests automatically. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services (http://aws.amazon.com/tools/).

We recommend that you use the AWS SDKs to make programmatic API calls to AWS KMS.

Clients must support TLS (Transport Layer Security) 1.0. We recommend TLS 1.2. Clients must also support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems such as Java 7 and later support these modes.

Signing Requests

Requests must be signed by using an access key ID and a secret access key. We strongly recommend that you do not use your AWS account (root) access key ID and secret key for everyday work with AWS KMS. Instead, use the access key ID and secret access key for an IAM user. You can also use the AWS Security Token Service to generate temporary security credentials that you can use to sign requests.

All AWS KMS operations require Signature Version 4 (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).

Logging API Requests

AWS KMS supports AWS CloudTrail, a service that logs AWS API calls and related events for your AWS account and delivers them to an Amazon S3 bucket that you specify. By using the information collected by CloudTrail, you can determine what requests were made to AWS KMS, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/).

Additional Resources

For more information about credentials and request signing, see the following:

* AWS Security Credentials (https://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html)
- This topic provides general information about the types of credentials
used for accessing AWS.

* Temporary Security Credentials (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html)
- This section of the IAM User Guide describes how to create and use temporary
security credentials.

* Signature Version 4 Signing Process (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html)
- This set of topics walks you through the process of signing a request
using an access key ID and a secret access key.

Commonly Used API Operations

Of the API operations discussed in this guide, the following will prove the most useful for most applications. You will likely perform operations other than these, such as creating keys and assigning policies, by using the console.

* Encrypt

* Decrypt

* GenerateDataKey

* GenerateDataKeyWithoutPlaintext

See https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01 for more information on this service.

See kms package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/kms/

Using the Client

To contact AWS Key Management Service with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS Key Management Service client KMS for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/kms/#New

The stub package, kmsiface, can be used to provide alternative implementations of service clients, such as mocking the client for testing.

Types ▾

type KMS
func New(p client.ConfigProvider, cfgs ...*aws.Config) *KMS
func (c *KMS) CancelKeyDeletion(input *CancelKeyDeletionInput) (*CancelKeyDeletionOutput, error)
func (c *KMS) CancelKeyDeletionRequest(input *CancelKeyDeletionInput) (req *request.Request, output *CancelKeyDeletionOutput)
func (c *KMS) CancelKeyDeletionWithContext(ctx aws.Context, input *CancelKeyDeletionInput, opts ...request.Option) (*CancelKeyDeletionOutput, error)
func (c *KMS) ConnectCustomKeyStore(input *ConnectCustomKeyStoreInput) (*ConnectCustomKeyStoreOutput, error)
func (c *KMS) ConnectCustomKeyStoreRequest(input *ConnectCustomKeyStoreInput) (req *request.Request, output *ConnectCustomKeyStoreOutput)
func (c *KMS) ConnectCustomKeyStoreWithContext(ctx aws.Context, input *ConnectCustomKeyStoreInput, opts ...request.Option) (*ConnectCustomKeyStoreOutput, error)
func (c *KMS) CreateAlias(input *CreateAliasInput) (*CreateAliasOutput, error)
func (c *KMS) CreateAliasRequest(input *CreateAliasInput) (req *request.Request, output *CreateAliasOutput)
func (c *KMS) CreateAliasWithContext(ctx aws.Context, input *CreateAliasInput, opts ...request.Option) (*CreateAliasOutput, error)
func (c *KMS) CreateCustomKeyStore(input *CreateCustomKeyStoreInput) (*CreateCustomKeyStoreOutput, error)
func (c *KMS) CreateCustomKeyStoreRequest(input *CreateCustomKeyStoreInput) (req *request.Request, output *CreateCustomKeyStoreOutput)
func (c *KMS) CreateCustomKeyStoreWithContext(ctx aws.Context, input *CreateCustomKeyStoreInput, opts ...request.Option) (*CreateCustomKeyStoreOutput, error)
func (c *KMS) CreateGrant(input *CreateGrantInput) (*CreateGrantOutput, error)
func (c *KMS) CreateGrantRequest(input *CreateGrantInput) (req *request.Request, output *CreateGrantOutput)
func (c *KMS) CreateGrantWithContext(ctx aws.Context, input *CreateGrantInput, opts ...request.Option) (*CreateGrantOutput, error)
func (c *KMS) CreateKey(input *CreateKeyInput) (*CreateKeyOutput, error)
func (c *KMS) CreateKeyRequest(input *CreateKeyInput) (req *request.Request, output *CreateKeyOutput)
func (c *KMS) CreateKeyWithContext(ctx aws.Context, input *CreateKeyInput, opts ...request.Option) (*CreateKeyOutput, error)
func (c *KMS) Decrypt(input *DecryptInput) (*DecryptOutput, error)
func (c *KMS) DecryptRequest(input *DecryptInput) (req *request.Request, output *DecryptOutput)
func (c *KMS) DecryptWithContext(ctx aws.Context, input *DecryptInput, opts ...request.Option) (*DecryptOutput, error)
func (c *KMS) DeleteAlias(input *DeleteAliasInput) (*DeleteAliasOutput, error)
func (c *KMS) DeleteAliasRequest(input *DeleteAliasInput) (req *request.Request, output *DeleteAliasOutput)
func (c *KMS) DeleteAliasWithContext(ctx aws.Context, input *DeleteAliasInput, opts ...request.Option) (*DeleteAliasOutput, error)
func (c *KMS) DeleteCustomKeyStore(input *DeleteCustomKeyStoreInput) (*DeleteCustomKeyStoreOutput, error)
func (c *KMS) DeleteCustomKeyStoreRequest(input *DeleteCustomKeyStoreInput) (req *request.Request, output *DeleteCustomKeyStoreOutput)
func (c *KMS) DeleteCustomKeyStoreWithContext(ctx aws.Context, input *DeleteCustomKeyStoreInput, opts ...request.Option) (*DeleteCustomKeyStoreOutput, error)
func (c *KMS) DeleteImportedKeyMaterial(input *DeleteImportedKeyMaterialInput) (*DeleteImportedKeyMaterialOutput, error)
func (c *KMS) DeleteImportedKeyMaterialRequest(input *DeleteImportedKeyMaterialInput) (req *request.Request, output *DeleteImportedKeyMaterialOutput)
func (c *KMS) DeleteImportedKeyMaterialWithContext(ctx aws.Context, input *DeleteImportedKeyMaterialInput, opts ...request.Option) (*DeleteImportedKeyMaterialOutput, error)
func (c *KMS) DescribeCustomKeyStores(input *DescribeCustomKeyStoresInput) (*DescribeCustomKeyStoresOutput, error)
func (c *KMS) DescribeCustomKeyStoresRequest(input *DescribeCustomKeyStoresInput) (req *request.Request, output *DescribeCustomKeyStoresOutput)
func (c *KMS) DescribeCustomKeyStoresWithContext(ctx aws.Context, input *DescribeCustomKeyStoresInput, opts ...request.Option) (*DescribeCustomKeyStoresOutput, error)
func (c *KMS) DescribeKey(input *DescribeKeyInput) (*DescribeKeyOutput, error)
func (c *KMS) DescribeKeyRequest(input *DescribeKeyInput) (req *request.Request, output *DescribeKeyOutput)
func (c *KMS) DescribeKeyWithContext(ctx aws.Context, input *DescribeKeyInput, opts ...request.Option) (*DescribeKeyOutput, error)
func (c *KMS) DisableKey(input *DisableKeyInput) (*DisableKeyOutput, error)
func (c *KMS) DisableKeyRequest(input *DisableKeyInput) (req *request.Request, output *DisableKeyOutput)
func (c *KMS) DisableKeyRotation(input *DisableKeyRotationInput) (*DisableKeyRotationOutput, error)
func (c *KMS) DisableKeyRotationRequest(input *DisableKeyRotationInput) (req *request.Request, output *DisableKeyRotationOutput)
func (c *KMS) DisableKeyRotationWithContext(ctx aws.Context, input *DisableKeyRotationInput, opts ...request.Option) (*DisableKeyRotationOutput, error)
func (c *KMS) DisableKeyWithContext(ctx aws.Context, input *DisableKeyInput, opts ...request.Option) (*DisableKeyOutput, error)
func (c *KMS) DisconnectCustomKeyStore(input *DisconnectCustomKeyStoreInput) (*DisconnectCustomKeyStoreOutput, error)
func (c *KMS) DisconnectCustomKeyStoreRequest(input *DisconnectCustomKeyStoreInput) (req *request.Request, output *DisconnectCustomKeyStoreOutput)
func (c *KMS) DisconnectCustomKeyStoreWithContext(ctx aws.Context, input *DisconnectCustomKeyStoreInput, opts ...request.Option) (*DisconnectCustomKeyStoreOutput, error)
func (c *KMS) EnableKey(input *EnableKeyInput) (*EnableKeyOutput, error)
func (c *KMS) EnableKeyRequest(input *EnableKeyInput) (req *request.Request, output *EnableKeyOutput)
func (c *KMS) EnableKeyRotation(input *EnableKeyRotationInput) (*EnableKeyRotationOutput, error)
func (c *KMS) EnableKeyRotationRequest(input *EnableKeyRotationInput) (req *request.Request, output *EnableKeyRotationOutput)
func (c *KMS) EnableKeyRotationWithContext(ctx aws.Context, input *EnableKeyRotationInput, opts ...request.Option) (*EnableKeyRotationOutput, error)
func (c *KMS) EnableKeyWithContext(ctx aws.Context, input *EnableKeyInput, opts ...request.Option) (*EnableKeyOutput, error)
func (c *KMS) Encrypt(input *EncryptInput) (*EncryptOutput, error)
func (c *KMS) EncryptRequest(input *EncryptInput) (req *request.Request, output *EncryptOutput)
func (c *KMS) EncryptWithContext(ctx aws.Context, input *EncryptInput, opts ...request.Option) (*EncryptOutput, error)
func (c *KMS) GenerateDataKey(input *GenerateDataKeyInput) (*GenerateDataKeyOutput, error)
func (c *KMS) GenerateDataKeyPair(input *GenerateDataKeyPairInput) (*GenerateDataKeyPairOutput, error)
func (c *KMS) GenerateDataKeyPairRequest(input *GenerateDataKeyPairInput) (req *request.Request, output *GenerateDataKeyPairOutput)
func (c *KMS) GenerateDataKeyPairWithContext(ctx aws.Context, input *GenerateDataKeyPairInput, opts ...request.Option) (*GenerateDataKeyPairOutput, error)
func (c *KMS) GenerateDataKeyPairWithoutPlaintext(input *GenerateDataKeyPairWithoutPlaintextInput) (*GenerateDataKeyPairWithoutPlaintextOutput, error)
func (c *KMS) GenerateDataKeyPairWithoutPlaintextRequest(input *GenerateDataKeyPairWithoutPlaintextInput) (req *request.Request, output *GenerateDataKeyPairWithoutPlaintextOutput)
func (c *KMS) GenerateDataKeyPairWithoutPlaintextWithContext(ctx aws.Context, input *GenerateDataKeyPairWithoutPlaintextInput, opts ...request.Option) (*GenerateDataKeyPairWithoutPlaintextOutput, error)
func (c *KMS) GenerateDataKeyRequest(input *GenerateDataKeyInput) (req *request.Request, output *GenerateDataKeyOutput)
func (c *KMS) GenerateDataKeyWithContext(ctx aws.Context, input *GenerateDataKeyInput, opts ...request.Option) (*GenerateDataKeyOutput, error)
func (c *KMS) GenerateDataKeyWithoutPlaintext(input *GenerateDataKeyWithoutPlaintextInput) (*GenerateDataKeyWithoutPlaintextOutput, error)
func (c *KMS) GenerateDataKeyWithoutPlaintextRequest(input *GenerateDataKeyWithoutPlaintextInput) (req *request.Request, output *GenerateDataKeyWithoutPlaintextOutput)
func (c *KMS) GenerateDataKeyWithoutPlaintextWithContext(ctx aws.Context, input *GenerateDataKeyWithoutPlaintextInput, opts ...request.Option) (*GenerateDataKeyWithoutPlaintextOutput, error)
func (c *KMS) GenerateRandom(input *GenerateRandomInput) (*GenerateRandomOutput, error)
func (c *KMS) GenerateRandomRequest(input *GenerateRandomInput) (req *request.Request, output *GenerateRandomOutput)
func (c *KMS) GenerateRandomWithContext(ctx aws.Context, input *GenerateRandomInput, opts ...request.Option) (*GenerateRandomOutput, error)
func (c *KMS) GetKeyPolicy(input *GetKeyPolicyInput) (*GetKeyPolicyOutput, error)
func (c *KMS) GetKeyPolicyRequest(input *GetKeyPolicyInput) (req *request.Request, output *GetKeyPolicyOutput)
func (c *KMS) GetKeyPolicyWithContext(ctx aws.Context, input *GetKeyPolicyInput, opts ...request.Option) (*GetKeyPolicyOutput, error)
func (c *KMS) GetKeyRotationStatus(input *GetKeyRotationStatusInput) (*GetKeyRotationStatusOutput, error)
func (c *KMS) GetKeyRotationStatusRequest(input *GetKeyRotationStatusInput) (req *request.Request, output *GetKeyRotationStatusOutput)
func (c *KMS) GetKeyRotationStatusWithContext(ctx aws.Context, input *GetKeyRotationStatusInput, opts ...request.Option) (*GetKeyRotationStatusOutput, error)
func (c *KMS) GetParametersForImport(input *GetParametersForImportInput) (*GetParametersForImportOutput, error)
func (c *KMS) GetParametersForImportRequest(input *GetParametersForImportInput) (req *request.Request, output *GetParametersForImportOutput)
func (c *KMS) GetParametersForImportWithContext(ctx aws.Context, input *GetParametersForImportInput, opts ...request.Option) (*GetParametersForImportOutput, error)
func (c *KMS) GetPublicKey(input *GetPublicKeyInput) (*GetPublicKeyOutput, error)
func (c *KMS) GetPublicKeyRequest(input *GetPublicKeyInput) (req *request.Request, output *GetPublicKeyOutput)
func (c *KMS) GetPublicKeyWithContext(ctx aws.Context, input *GetPublicKeyInput, opts ...request.Option) (*GetPublicKeyOutput, error)
func (c *KMS) ImportKeyMaterial(input *ImportKeyMaterialInput) (*ImportKeyMaterialOutput, error)
func (c *KMS) ImportKeyMaterialRequest(input *ImportKeyMaterialInput) (req *request.Request, output *ImportKeyMaterialOutput)
func (c *KMS) ImportKeyMaterialWithContext(ctx aws.Context, input *ImportKeyMaterialInput, opts ...request.Option) (*ImportKeyMaterialOutput, error)
func (c *KMS) ListAliases(input *ListAliasesInput) (*ListAliasesOutput, error)
func (c *KMS) ListAliasesPages(input *ListAliasesInput, fn func(*ListAliasesOutput, bool) bool) error
func (c *KMS) ListAliasesPagesWithContext(ctx aws.Context, input *ListAliasesInput, fn func(*ListAliasesOutput, bool) bool, opts ...request.Option) error
func (c *KMS) ListAliasesRequest(input *ListAliasesInput) (req *request.Request, output *ListAliasesOutput)
func (c *KMS) ListAliasesWithContext(ctx aws.Context, input *ListAliasesInput, opts ...request.Option) (*ListAliasesOutput, error)
func (c *KMS) ListGrants(input *ListGrantsInput) (*ListGrantsResponse, error)
func (c *KMS) ListGrantsPages(input *ListGrantsInput, fn func(*ListGrantsResponse, bool) bool) error
func (c *KMS) ListGrantsPagesWithContext(ctx aws.Context, input *ListGrantsInput, fn func(*ListGrantsResponse, bool) bool, opts ...request.Option) error
func (c *KMS) ListGrantsRequest(input *ListGrantsInput) (req *request.Request, output *ListGrantsResponse)
func (c *KMS) ListGrantsWithContext(ctx aws.Context, input *ListGrantsInput, opts ...request.Option) (*ListGrantsResponse, error)
func (c *KMS) ListKeyPolicies(input *ListKeyPoliciesInput) (*ListKeyPoliciesOutput, error)
func (c *KMS) ListKeyPoliciesPages(input *ListKeyPoliciesInput, fn func(*ListKeyPoliciesOutput, bool) bool) error
func (c *KMS) ListKeyPoliciesPagesWithContext(ctx aws.Context, input *ListKeyPoliciesInput, fn func(*ListKeyPoliciesOutput, bool) bool, opts ...request.Option) error
func (c *KMS) ListKeyPoliciesRequest(input *ListKeyPoliciesInput) (req *request.Request, output *ListKeyPoliciesOutput)
func (c *KMS) ListKeyPoliciesWithContext(ctx aws.Context, input *ListKeyPoliciesInput, opts ...request.Option) (*ListKeyPoliciesOutput, error)
func (c *KMS) ListKeys(input *ListKeysInput) (*ListKeysOutput, error)
func (c *KMS) ListKeysPages(input *ListKeysInput, fn func(*ListKeysOutput, bool) bool) error
func (c *KMS) ListKeysPagesWithContext(ctx aws.Context, input *ListKeysInput, fn func(*ListKeysOutput, bool) bool, opts ...request.Option) error
func (c *KMS) ListKeysRequest(input *ListKeysInput) (req *request.Request, output *ListKeysOutput)
func (c *KMS) ListKeysWithContext(ctx aws.Context, input *ListKeysInput, opts ...request.Option) (*ListKeysOutput, error)
func (c *KMS) ListResourceTags(input *ListResourceTagsInput) (*ListResourceTagsOutput, error)
func (c *KMS) ListResourceTagsRequest(input *ListResourceTagsInput) (req *request.Request, output *ListResourceTagsOutput)
func (c *KMS) ListResourceTagsWithContext(ctx aws.Context, input *ListResourceTagsInput, opts ...request.Option) (*ListResourceTagsOutput, error)
func (c *KMS) ListRetirableGrants(input *ListRetirableGrantsInput) (*ListGrantsResponse, error)
func (c *KMS) ListRetirableGrantsRequest(input *ListRetirableGrantsInput) (req *request.Request, output *ListGrantsResponse)
func (c *KMS) ListRetirableGrantsWithContext(ctx aws.Context, input *ListRetirableGrantsInput, opts ...request.Option) (*ListGrantsResponse, error)
func (c *KMS) PutKeyPolicy(input *PutKeyPolicyInput) (*PutKeyPolicyOutput, error)
func (c *KMS) PutKeyPolicyRequest(input *PutKeyPolicyInput) (req *request.Request, output *PutKeyPolicyOutput)
func (c *KMS) PutKeyPolicyWithContext(ctx aws.Context, input *PutKeyPolicyInput, opts ...request.Option) (*PutKeyPolicyOutput, error)
func (c *KMS) ReEncrypt(input *ReEncryptInput) (*ReEncryptOutput, error)
func (c *KMS) ReEncryptRequest(input *ReEncryptInput) (req *request.Request, output *ReEncryptOutput)
func (c *KMS) ReEncryptWithContext(ctx aws.Context, input *ReEncryptInput, opts ...request.Option) (*ReEncryptOutput, error)
func (c *KMS) RetireGrant(input *RetireGrantInput) (*RetireGrantOutput, error)
func (c *KMS) RetireGrantRequest(input *RetireGrantInput) (req *request.Request, output *RetireGrantOutput)
func (c *KMS) RetireGrantWithContext(ctx aws.Context, input *RetireGrantInput, opts ...request.Option) (*RetireGrantOutput, error)
func (c *KMS) RevokeGrant(input *RevokeGrantInput) (*RevokeGrantOutput, error)
func (c *KMS) RevokeGrantRequest(input *RevokeGrantInput) (req *request.Request, output *RevokeGrantOutput)
func (c *KMS) RevokeGrantWithContext(ctx aws.Context, input *RevokeGrantInput, opts ...request.Option) (*RevokeGrantOutput, error)
func (c *KMS) ScheduleKeyDeletion(input *ScheduleKeyDeletionInput) (*ScheduleKeyDeletionOutput, error)
func (c *KMS) ScheduleKeyDeletionRequest(input *ScheduleKeyDeletionInput) (req *request.Request, output *ScheduleKeyDeletionOutput)
func (c *KMS) ScheduleKeyDeletionWithContext(ctx aws.Context, input *ScheduleKeyDeletionInput, opts ...request.Option) (*ScheduleKeyDeletionOutput, error)
func (c *KMS) Sign(input *SignInput) (*SignOutput, error)
func (c *KMS) SignRequest(input *SignInput) (req *request.Request, output *SignOutput)
func (c *KMS) SignWithContext(ctx aws.Context, input *SignInput, opts ...request.Option) (*SignOutput, error)
func (c *KMS) TagResource(input *TagResourceInput) (*TagResourceOutput, error)
func (c *KMS) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)
func (c *KMS) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)
func (c *KMS) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)
func (c *KMS) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)
func (c *KMS) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)
func (c *KMS) UpdateAlias(input *UpdateAliasInput) (*UpdateAliasOutput, error)
func (c *KMS) UpdateAliasRequest(input *UpdateAliasInput) (req *request.Request, output *UpdateAliasOutput)
func (c *KMS) UpdateAliasWithContext(ctx aws.Context, input *UpdateAliasInput, opts ...request.Option) (*UpdateAliasOutput, error)
func (c *KMS) UpdateCustomKeyStore(input *UpdateCustomKeyStoreInput) (*UpdateCustomKeyStoreOutput, error)
func (c *KMS) UpdateCustomKeyStoreRequest(input *UpdateCustomKeyStoreInput) (req *request.Request, output *UpdateCustomKeyStoreOutput)
func (c *KMS) UpdateCustomKeyStoreWithContext(ctx aws.Context, input *UpdateCustomKeyStoreInput, opts ...request.Option) (*UpdateCustomKeyStoreOutput, error)
func (c *KMS) UpdateKeyDescription(input *UpdateKeyDescriptionInput) (*UpdateKeyDescriptionOutput, error)
func (c *KMS) UpdateKeyDescriptionRequest(input *UpdateKeyDescriptionInput) (req *request.Request, output *UpdateKeyDescriptionOutput)
func (c *KMS) UpdateKeyDescriptionWithContext(ctx aws.Context, input *UpdateKeyDescriptionInput, opts ...request.Option) (*UpdateKeyDescriptionOutput, error)
func (c *KMS) Verify(input *VerifyInput) (*VerifyOutput, error)
func (c *KMS) VerifyRequest(input *VerifyInput) (req *request.Request, output *VerifyOutput)
func (c *KMS) VerifyWithContext(ctx aws.Context, input *VerifyInput, opts ...request.Option) (*VerifyOutput, error)
func AlgorithmSpec_Values() []string
func ConnectionErrorCodeType_Values() []string
func ConnectionStateType_Values() []string
func CustomerMasterKeySpec_Values() []string
func DataKeyPairSpec_Values() []string
func DataKeySpec_Values() []string
func EncryptionAlgorithmSpec_Values() []string
func ExpirationModelType_Values() []string
func GrantOperation_Values() []string
func KeyManagerType_Values() []string
func KeyState_Values() []string
func KeyUsageType_Values() []string
func MessageType_Values() []string
func OriginType_Values() []string
func SigningAlgorithmSpec_Values() []string
func WrappingKeySpec_Values() []string
type AliasListEntry
type AlreadyExistsException
type CancelKeyDeletionInput
type CancelKeyDeletionOutput
type CloudHsmClusterInUseException
type CloudHsmClusterInvalidConfigurationException
type CloudHsmClusterNotActiveException
type CloudHsmClusterNotFoundException
type CloudHsmClusterNotRelatedException
type ConnectCustomKeyStoreInput
type ConnectCustomKeyStoreOutput
type CreateAliasInput
type CreateAliasOutput
type CreateCustomKeyStoreInput
type CreateCustomKeyStoreOutput
type CreateGrantInput
type CreateGrantOutput
type CreateKeyInput
type CreateKeyOutput
type CustomKeyStoreHasCMKsException
type CustomKeyStoreInvalidStateException
type CustomKeyStoreNameInUseException
type CustomKeyStoreNotFoundException
type CustomKeyStoresListEntry
type DecryptInput
type DecryptOutput
type DeleteAliasInput
type DeleteAliasOutput
type DeleteCustomKeyStoreInput
type DeleteCustomKeyStoreOutput
type DeleteImportedKeyMaterialInput
type DeleteImportedKeyMaterialOutput
type DependencyTimeoutException
type DescribeCustomKeyStoresInput
type DescribeCustomKeyStoresOutput
type DescribeKeyInput
type DescribeKeyOutput
type DisableKeyInput
type DisableKeyOutput
type DisableKeyRotationInput
type DisableKeyRotationOutput
type DisabledException
type DisconnectCustomKeyStoreInput
type DisconnectCustomKeyStoreOutput
type EnableKeyInput
type EnableKeyOutput
type EnableKeyRotationInput
type EnableKeyRotationOutput
type EncryptInput
type EncryptOutput
type ExpiredImportTokenException
type GenerateDataKeyInput
type GenerateDataKeyOutput
type GenerateDataKeyPairInput
type GenerateDataKeyPairOutput
type GenerateDataKeyPairWithoutPlaintextInput
type GenerateDataKeyPairWithoutPlaintextOutput
type GenerateDataKeyWithoutPlaintextInput
type GenerateDataKeyWithoutPlaintextOutput
type GenerateRandomInput
type GenerateRandomOutput
type GetKeyPolicyInput
type GetKeyPolicyOutput
type GetKeyRotationStatusInput
type GetKeyRotationStatusOutput
type GetParametersForImportInput
type GetParametersForImportOutput
type GetPublicKeyInput
type GetPublicKeyOutput
type GrantConstraints
type GrantListEntry
type ImportKeyMaterialInput
type ImportKeyMaterialOutput
type IncorrectKeyException
type IncorrectKeyMaterialException
type IncorrectTrustAnchorException
type InternalException
type InvalidAliasNameException
type InvalidArnException
type InvalidCiphertextException
type InvalidGrantIdException
type InvalidGrantTokenException
type InvalidImportTokenException
type InvalidKeyUsageException
type InvalidMarkerException
type InvalidStateException
type KMSInvalidSignatureException
type KeyListEntry
type KeyMetadata
type KeyUnavailableException
type LimitExceededException
type ListAliasesInput
type ListAliasesOutput
type ListGrantsInput
type ListGrantsResponse
type ListKeyPoliciesInput
type ListKeyPoliciesOutput
type ListKeysInput
type ListKeysOutput
type ListResourceTagsInput
type ListResourceTagsOutput
type ListRetirableGrantsInput
type MalformedPolicyDocumentException
type NotFoundException
type PutKeyPolicyInput
type PutKeyPolicyOutput
type ReEncryptInput
type ReEncryptOutput
type RetireGrantInput
type RetireGrantOutput
type RevokeGrantInput
type RevokeGrantOutput
type ScheduleKeyDeletionInput
type ScheduleKeyDeletionOutput
type SignInput
type SignOutput
type Tag
type TagException
type TagResourceInput
type TagResourceOutput
type UnsupportedOperationException
type UntagResourceInput
type UntagResourceOutput
type UpdateAliasInput
type UpdateAliasOutput
type UpdateCustomKeyStoreInput
type UpdateCustomKeyStoreOutput
type UpdateKeyDescriptionInput
type UpdateKeyDescriptionOutput
type VerifyInput
type VerifyOutput

Constants ▾

const (
    // AlgorithmSpecRsaesPkcs1V15 is a AlgorithmSpec enum value
    AlgorithmSpecRsaesPkcs1V15 = "RSAES_PKCS1_V1_5"

    // AlgorithmSpecRsaesOaepSha1 is a AlgorithmSpec enum value
    AlgorithmSpecRsaesOaepSha1 = "RSAES_OAEP_SHA_1"

    // AlgorithmSpecRsaesOaepSha256 is a AlgorithmSpec enum value
    AlgorithmSpecRsaesOaepSha256 = "RSAES_OAEP_SHA_256"
)
const (
    // ConnectionErrorCodeTypeInvalidCredentials is a ConnectionErrorCodeType enum value
    ConnectionErrorCodeTypeInvalidCredentials = "INVALID_CREDENTIALS"

    // ConnectionErrorCodeTypeClusterNotFound is a ConnectionErrorCodeType enum value
    ConnectionErrorCodeTypeClusterNotFound = "CLUSTER_NOT_FOUND"

    // ConnectionErrorCodeTypeNetworkErrors is a ConnectionErrorCodeType enum value
    ConnectionErrorCodeTypeNetworkErrors = "NETWORK_ERRORS"

    // ConnectionErrorCodeTypeInternalError is a ConnectionErrorCodeType enum value
    ConnectionErrorCodeTypeInternalError = "INTERNAL_ERROR"

    // ConnectionErrorCodeTypeInsufficientCloudhsmHsms is a ConnectionErrorCodeType enum value
    ConnectionErrorCodeTypeInsufficientCloudhsmHsms = "INSUFFICIENT_CLOUDHSM_HSMS"

    // ConnectionErrorCodeTypeUserLockedOut is a ConnectionErrorCodeType enum value
    ConnectionErrorCodeTypeUserLockedOut = "USER_LOCKED_OUT"

    // ConnectionErrorCodeTypeUserNotFound is a ConnectionErrorCodeType enum value
    ConnectionErrorCodeTypeUserNotFound = "USER_NOT_FOUND"

    // ConnectionErrorCodeTypeUserLoggedIn is a ConnectionErrorCodeType enum value
    ConnectionErrorCodeTypeUserLoggedIn = "USER_LOGGED_IN"

    // ConnectionErrorCodeTypeSubnetNotFound is a ConnectionErrorCodeType enum value
    ConnectionErrorCodeTypeSubnetNotFound = "SUBNET_NOT_FOUND"
)
const (
    // ConnectionStateTypeConnected is a ConnectionStateType enum value
    ConnectionStateTypeConnected = "CONNECTED"

    // ConnectionStateTypeConnecting is a ConnectionStateType enum value
    ConnectionStateTypeConnecting = "CONNECTING"

    // ConnectionStateTypeFailed is a ConnectionStateType enum value
    ConnectionStateTypeFailed = "FAILED"

    // ConnectionStateTypeDisconnected is a ConnectionStateType enum value
    ConnectionStateTypeDisconnected = "DISCONNECTED"

    // ConnectionStateTypeDisconnecting is a ConnectionStateType enum value
    ConnectionStateTypeDisconnecting = "DISCONNECTING"
)
const (
    // CustomerMasterKeySpecRsa2048 is a CustomerMasterKeySpec enum value
    CustomerMasterKeySpecRsa2048 = "RSA_2048"

    // CustomerMasterKeySpecRsa3072 is a CustomerMasterKeySpec enum value
    CustomerMasterKeySpecRsa3072 = "RSA_3072"

    // CustomerMasterKeySpecRsa4096 is a CustomerMasterKeySpec enum value
    CustomerMasterKeySpecRsa4096 = "RSA_4096"

    // CustomerMasterKeySpecEccNistP256 is a CustomerMasterKeySpec enum value
    CustomerMasterKeySpecEccNistP256 = "ECC_NIST_P256"

    // CustomerMasterKeySpecEccNistP384 is a CustomerMasterKeySpec enum value
    CustomerMasterKeySpecEccNistP384 = "ECC_NIST_P384"

    // CustomerMasterKeySpecEccNistP521 is a CustomerMasterKeySpec enum value
    CustomerMasterKeySpecEccNistP521 = "ECC_NIST_P521"

    // CustomerMasterKeySpecEccSecgP256k1 is a CustomerMasterKeySpec enum value
    CustomerMasterKeySpecEccSecgP256k1 = "ECC_SECG_P256K1"

    // CustomerMasterKeySpecSymmetricDefault is a CustomerMasterKeySpec enum value
    CustomerMasterKeySpecSymmetricDefault = "SYMMETRIC_DEFAULT"
)
const (
    // DataKeyPairSpecRsa2048 is a DataKeyPairSpec enum value
    DataKeyPairSpecRsa2048 = "RSA_2048"

    // DataKeyPairSpecRsa3072 is a DataKeyPairSpec enum value
    DataKeyPairSpecRsa3072 = "RSA_3072"

    // DataKeyPairSpecRsa4096 is a DataKeyPairSpec enum value
    DataKeyPairSpecRsa4096 = "RSA_4096"

    // DataKeyPairSpecEccNistP256 is a DataKeyPairSpec enum value
    DataKeyPairSpecEccNistP256 = "ECC_NIST_P256"

    // DataKeyPairSpecEccNistP384 is a DataKeyPairSpec enum value
    DataKeyPairSpecEccNistP384 = "ECC_NIST_P384"

    // DataKeyPairSpecEccNistP521 is a DataKeyPairSpec enum value
    DataKeyPairSpecEccNistP521 = "ECC_NIST_P521"

    // DataKeyPairSpecEccSecgP256k1 is a DataKeyPairSpec enum value
    DataKeyPairSpecEccSecgP256k1 = "ECC_SECG_P256K1"
)
const (
    // DataKeySpecAes256 is a DataKeySpec enum value
    DataKeySpecAes256 = "AES_256"

    // DataKeySpecAes128 is a DataKeySpec enum value
    DataKeySpecAes128 = "AES_128"
)
const (
    // EncryptionAlgorithmSpecSymmetricDefault is a EncryptionAlgorithmSpec enum value
    EncryptionAlgorithmSpecSymmetricDefault = "SYMMETRIC_DEFAULT"

    // EncryptionAlgorithmSpecRsaesOaepSha1 is a EncryptionAlgorithmSpec enum value
    EncryptionAlgorithmSpecRsaesOaepSha1 = "RSAES_OAEP_SHA_1"

    // EncryptionAlgorithmSpecRsaesOaepSha256 is a EncryptionAlgorithmSpec enum value
    EncryptionAlgorithmSpecRsaesOaepSha256 = "RSAES_OAEP_SHA_256"
)
const (
    // ExpirationModelTypeKeyMaterialExpires is a ExpirationModelType enum value
    ExpirationModelTypeKeyMaterialExpires = "KEY_MATERIAL_EXPIRES"

    // ExpirationModelTypeKeyMaterialDoesNotExpire is a ExpirationModelType enum value
    ExpirationModelTypeKeyMaterialDoesNotExpire = "KEY_MATERIAL_DOES_NOT_EXPIRE"
)
const (
    // GrantOperationDecrypt is a GrantOperation enum value
    GrantOperationDecrypt = "Decrypt"

    // GrantOperationEncrypt is a GrantOperation enum value
    GrantOperationEncrypt = "Encrypt"

    // GrantOperationGenerateDataKey is a GrantOperation enum value
    GrantOperationGenerateDataKey = "GenerateDataKey"

    // GrantOperationGenerateDataKeyWithoutPlaintext is a GrantOperation enum value
    GrantOperationGenerateDataKeyWithoutPlaintext = "GenerateDataKeyWithoutPlaintext"

    // GrantOperationReEncryptFrom is a GrantOperation enum value
    GrantOperationReEncryptFrom = "ReEncryptFrom"

    // GrantOperationReEncryptTo is a GrantOperation enum value
    GrantOperationReEncryptTo = "ReEncryptTo"

    // GrantOperationSign is a GrantOperation enum value
    GrantOperationSign = "Sign"

    // GrantOperationVerify is a GrantOperation enum value
    GrantOperationVerify = "Verify"

    // GrantOperationGetPublicKey is a GrantOperation enum value
    GrantOperationGetPublicKey = "GetPublicKey"

    // GrantOperationCreateGrant is a GrantOperation enum value
    GrantOperationCreateGrant = "CreateGrant"

    // GrantOperationRetireGrant is a GrantOperation enum value
    GrantOperationRetireGrant = "RetireGrant"

    // GrantOperationDescribeKey is a GrantOperation enum value
    GrantOperationDescribeKey = "DescribeKey"

    // GrantOperationGenerateDataKeyPair is a GrantOperation enum value
    GrantOperationGenerateDataKeyPair = "GenerateDataKeyPair"

    // GrantOperationGenerateDataKeyPairWithoutPlaintext is a GrantOperation enum value
    GrantOperationGenerateDataKeyPairWithoutPlaintext = "GenerateDataKeyPairWithoutPlaintext"
)
const (
    // KeyManagerTypeAws is a KeyManagerType enum value
    KeyManagerTypeAws = "AWS"

    // KeyManagerTypeCustomer is a KeyManagerType enum value
    KeyManagerTypeCustomer = "CUSTOMER"
)
const (
    // KeyStateEnabled is a KeyState enum value
    KeyStateEnabled = "Enabled"

    // KeyStateDisabled is a KeyState enum value
    KeyStateDisabled = "Disabled"

    // KeyStatePendingDeletion is a KeyState enum value
    KeyStatePendingDeletion = "PendingDeletion"

    // KeyStatePendingImport is a KeyState enum value
    KeyStatePendingImport = "PendingImport"

    // KeyStateUnavailable is a KeyState enum value
    KeyStateUnavailable = "Unavailable"
)
const (
    // KeyUsageTypeSignVerify is a KeyUsageType enum value
    KeyUsageTypeSignVerify = "SIGN_VERIFY"

    // KeyUsageTypeEncryptDecrypt is a KeyUsageType enum value
    KeyUsageTypeEncryptDecrypt = "ENCRYPT_DECRYPT"
)
const (
    // MessageTypeRaw is a MessageType enum value
    MessageTypeRaw = "RAW"

    // MessageTypeDigest is a MessageType enum value
    MessageTypeDigest = "DIGEST"
)
const (
    // OriginTypeAwsKms is a OriginType enum value
    OriginTypeAwsKms = "AWS_KMS"

    // OriginTypeExternal is a OriginType enum value
    OriginTypeExternal = "EXTERNAL"

    // OriginTypeAwsCloudhsm is a OriginType enum value
    OriginTypeAwsCloudhsm = "AWS_CLOUDHSM"
)
const (
    // SigningAlgorithmSpecRsassaPssSha256 is a SigningAlgorithmSpec enum value
    SigningAlgorithmSpecRsassaPssSha256 = "RSASSA_PSS_SHA_256"

    // SigningAlgorithmSpecRsassaPssSha384 is a SigningAlgorithmSpec enum value
    SigningAlgorithmSpecRsassaPssSha384 = "RSASSA_PSS_SHA_384"

    // SigningAlgorithmSpecRsassaPssSha512 is a SigningAlgorithmSpec enum value
    SigningAlgorithmSpecRsassaPssSha512 = "RSASSA_PSS_SHA_512"

    // SigningAlgorithmSpecRsassaPkcs1V15Sha256 is a SigningAlgorithmSpec enum value
    SigningAlgorithmSpecRsassaPkcs1V15Sha256 = "RSASSA_PKCS1_V1_5_SHA_256"

    // SigningAlgorithmSpecRsassaPkcs1V15Sha384 is a SigningAlgorithmSpec enum value
    SigningAlgorithmSpecRsassaPkcs1V15Sha384 = "RSASSA_PKCS1_V1_5_SHA_384"

    // SigningAlgorithmSpecRsassaPkcs1V15Sha512 is a SigningAlgorithmSpec enum value
    SigningAlgorithmSpecRsassaPkcs1V15Sha512 = "RSASSA_PKCS1_V1_5_SHA_512"

    // SigningAlgorithmSpecEcdsaSha256 is a SigningAlgorithmSpec enum value
    SigningAlgorithmSpecEcdsaSha256 = "ECDSA_SHA_256"

    // SigningAlgorithmSpecEcdsaSha384 is a SigningAlgorithmSpec enum value
    SigningAlgorithmSpecEcdsaSha384 = "ECDSA_SHA_384"

    // SigningAlgorithmSpecEcdsaSha512 is a SigningAlgorithmSpec enum value
    SigningAlgorithmSpecEcdsaSha512 = "ECDSA_SHA_512"
)
const (

    // ErrCodeAlreadyExistsException for service response error code
    // "AlreadyExistsException".
    //
    // The request was rejected because it attempted to create a resource that already
    // exists.
    ErrCodeAlreadyExistsException = "AlreadyExistsException"

    // ErrCodeCloudHsmClusterInUseException for service response error code
    // "CloudHsmClusterInUseException".
    //
    // The request was rejected because the specified AWS CloudHSM cluster is already
    // associated with a custom key store or it shares a backup history with a cluster
    // that is associated with a custom key store. Each custom key store must be
    // associated with a different AWS CloudHSM cluster.
    //
    // Clusters that share a backup history have the same cluster certificate. To
    // view the cluster certificate of a cluster, use the DescribeClusters (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html)
    // operation.
    ErrCodeCloudHsmClusterInUseException = "CloudHsmClusterInUseException"

    // ErrCodeCloudHsmClusterInvalidConfigurationException for service response error code
    // "CloudHsmClusterInvalidConfigurationException".
    //
    // The request was rejected because the associated AWS CloudHSM cluster did
    // not meet the configuration requirements for a custom key store.
    //
    //    * The cluster must be configured with private subnets in at least two
    //    different Availability Zones in the Region.
    //
    //    * The security group for the cluster (https://docs.aws.amazon.com/cloudhsm/latest/userguide/configure-sg.html)
    //    (cloudhsm-cluster-<cluster-id>-sg) must include inbound rules and outbound
    //    rules that allow TCP traffic on ports 2223-2225. The Source in the inbound
    //    rules and the Destination in the outbound rules must match the security
    //    group ID. These rules are set by default when you create the cluster.
    //    Do not delete or change them. To get information about a particular security
    //    group, use the DescribeSecurityGroups (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSecurityGroups.html)
    //    operation.
    //
    //    * The cluster must contain at least as many HSMs as the operation requires.
    //    To add HSMs, use the AWS CloudHSM CreateHsm (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_CreateHsm.html)
    //    operation. For the CreateCustomKeyStore, UpdateCustomKeyStore, and CreateKey
    //    operations, the AWS CloudHSM cluster must have at least two active HSMs,
    //    each in a different Availability Zone. For the ConnectCustomKeyStore operation,
    //    the AWS CloudHSM must contain at least one active HSM.
    //
    // For information about the requirements for an AWS CloudHSM cluster that is
    // associated with a custom key store, see Assemble the Prerequisites (https://docs.aws.amazon.com/kms/latest/developerguide/create-keystore.html#before-keystore)
    // in the AWS Key Management Service Developer Guide. For information about
    // creating a private subnet for an AWS CloudHSM cluster, see Create a Private
    // Subnet (https://docs.aws.amazon.com/cloudhsm/latest/userguide/create-subnets.html)
    // in the AWS CloudHSM User Guide. For information about cluster security groups,
    // see Configure a Default Security Group (https://docs.aws.amazon.com/cloudhsm/latest/userguide/configure-sg.html)
    // in the AWS CloudHSM User Guide .
    ErrCodeCloudHsmClusterInvalidConfigurationException = "CloudHsmClusterInvalidConfigurationException"

    // ErrCodeCloudHsmClusterNotActiveException for service response error code
    // "CloudHsmClusterNotActiveException".
    //
    // The request was rejected because the AWS CloudHSM cluster that is associated
    // with the custom key store is not active. Initialize and activate the cluster
    // and try the command again. For detailed instructions, see Getting Started
    // (https://docs.aws.amazon.com/cloudhsm/latest/userguide/getting-started.html)
    // in the AWS CloudHSM User Guide.
    ErrCodeCloudHsmClusterNotActiveException = "CloudHsmClusterNotActiveException"

    // ErrCodeCloudHsmClusterNotFoundException for service response error code
    // "CloudHsmClusterNotFoundException".
    //
    // The request was rejected because AWS KMS cannot find the AWS CloudHSM cluster
    // with the specified cluster ID. Retry the request with a different cluster
    // ID.
    ErrCodeCloudHsmClusterNotFoundException = "CloudHsmClusterNotFoundException"

    // ErrCodeCloudHsmClusterNotRelatedException for service response error code
    // "CloudHsmClusterNotRelatedException".
    //
    // The request was rejected because the specified AWS CloudHSM cluster has a
    // different cluster certificate than the original cluster. You cannot use the
    // operation to specify an unrelated cluster.
    //
    // Specify a cluster that shares a backup history with the original cluster.
    // This includes clusters that were created from a backup of the current cluster,
    // and clusters that were created from the same backup that produced the current
    // cluster.
    //
    // Clusters that share a backup history have the same cluster certificate. To
    // view the cluster certificate of a cluster, use the DescribeClusters (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html)
    // operation.
    ErrCodeCloudHsmClusterNotRelatedException = "CloudHsmClusterNotRelatedException"

    // ErrCodeCustomKeyStoreHasCMKsException for service response error code
    // "CustomKeyStoreHasCMKsException".
    //
    // The request was rejected because the custom key store contains AWS KMS customer
    // master keys (CMKs). After verifying that you do not need to use the CMKs,
    // use the ScheduleKeyDeletion operation to delete the CMKs. After they are
    // deleted, you can delete the custom key store.
    ErrCodeCustomKeyStoreHasCMKsException = "CustomKeyStoreHasCMKsException"

    // ErrCodeCustomKeyStoreInvalidStateException for service response error code
    // "CustomKeyStoreInvalidStateException".
    //
    // The request was rejected because of the ConnectionState of the custom key
    // store. To get the ConnectionState of a custom key store, use the DescribeCustomKeyStores
    // operation.
    //
    // This exception is thrown under the following conditions:
    //
    //    * You requested the CreateKey or GenerateRandom operation in a custom
    //    key store that is not connected. These operations are valid only when
    //    the custom key store ConnectionState is CONNECTED.
    //
    //    * You requested the UpdateCustomKeyStore or DeleteCustomKeyStore operation
    //    on a custom key store that is not disconnected. This operation is valid
    //    only when the custom key store ConnectionState is DISCONNECTED.
    //
    //    * You requested the ConnectCustomKeyStore operation on a custom key store
    //    with a ConnectionState of DISCONNECTING or FAILED. This operation is valid
    //    for all other ConnectionState values.
    ErrCodeCustomKeyStoreInvalidStateException = "CustomKeyStoreInvalidStateException"

    // ErrCodeCustomKeyStoreNameInUseException for service response error code
    // "CustomKeyStoreNameInUseException".
    //
    // The request was rejected because the specified custom key store name is already
    // assigned to another custom key store in the account. Try again with a custom
    // key store name that is unique in the account.
    ErrCodeCustomKeyStoreNameInUseException = "CustomKeyStoreNameInUseException"

    // ErrCodeCustomKeyStoreNotFoundException for service response error code
    // "CustomKeyStoreNotFoundException".
    //
    // The request was rejected because AWS KMS cannot find a custom key store with
    // the specified key store name or ID.
    ErrCodeCustomKeyStoreNotFoundException = "CustomKeyStoreNotFoundException"

    // ErrCodeDependencyTimeoutException for service response error code
    // "DependencyTimeoutException".
    //
    // The system timed out while trying to fulfill the request. The request can
    // be retried.
    ErrCodeDependencyTimeoutException = "DependencyTimeoutException"

    // ErrCodeDisabledException for service response error code
    // "DisabledException".
    //
    // The request was rejected because the specified CMK is not enabled.
    ErrCodeDisabledException = "DisabledException"

    // ErrCodeExpiredImportTokenException for service response error code
    // "ExpiredImportTokenException".
    //
    // The request was rejected because the specified import token is expired. Use
    // GetParametersForImport to get a new import token and public key, use the
    // new public key to encrypt the key material, and then try the request again.
    ErrCodeExpiredImportTokenException = "ExpiredImportTokenException"

    // ErrCodeIncorrectKeyException for service response error code
    // "IncorrectKeyException".
    //
    // The request was rejected because the specified CMK cannot decrypt the data.
    // The KeyId in a Decrypt request and the SourceKeyId in a ReEncrypt request
    // must identify the same CMK that was used to encrypt the ciphertext.
    ErrCodeIncorrectKeyException = "IncorrectKeyException"

    // ErrCodeIncorrectKeyMaterialException for service response error code
    // "IncorrectKeyMaterialException".
    //
    // The request was rejected because the key material in the request is, expired,
    // invalid, or is not the same key material that was previously imported into
    // this customer master key (CMK).
    ErrCodeIncorrectKeyMaterialException = "IncorrectKeyMaterialException"

    // ErrCodeIncorrectTrustAnchorException for service response error code
    // "IncorrectTrustAnchorException".
    //
    // The request was rejected because the trust anchor certificate in the request
    // is not the trust anchor certificate for the specified AWS CloudHSM cluster.
    //
    // When you initialize the cluster (https://docs.aws.amazon.com/cloudhsm/latest/userguide/initialize-cluster.html#sign-csr),
    // you create the trust anchor certificate and save it in the customerCA.crt
    // file.
    ErrCodeIncorrectTrustAnchorException = "IncorrectTrustAnchorException"

    // ErrCodeInternalException for service response error code
    // "KMSInternalException".
    //
    // The request was rejected because an internal exception occurred. The request
    // can be retried.
    ErrCodeInternalException = "KMSInternalException"

    // ErrCodeInvalidAliasNameException for service response error code
    // "InvalidAliasNameException".
    //
    // The request was rejected because the specified alias name is not valid.
    ErrCodeInvalidAliasNameException = "InvalidAliasNameException"

    // ErrCodeInvalidArnException for service response error code
    // "InvalidArnException".
    //
    // The request was rejected because a specified ARN, or an ARN in a key policy,
    // is not valid.
    ErrCodeInvalidArnException = "InvalidArnException"

    // ErrCodeInvalidCiphertextException for service response error code
    // "InvalidCiphertextException".
    //
    // From the Decrypt or ReEncrypt operation, the request was rejected because
    // the specified ciphertext, or additional authenticated data incorporated into
    // the ciphertext, such as the encryption context, is corrupted, missing, or
    // otherwise invalid.
    //
    // From the ImportKeyMaterial operation, the request was rejected because AWS
    // KMS could not decrypt the encrypted (wrapped) key material.
    ErrCodeInvalidCiphertextException = "InvalidCiphertextException"

    // ErrCodeInvalidGrantIdException for service response error code
    // "InvalidGrantIdException".
    //
    // The request was rejected because the specified GrantId is not valid.
    ErrCodeInvalidGrantIdException = "InvalidGrantIdException"

    // ErrCodeInvalidGrantTokenException for service response error code
    // "InvalidGrantTokenException".
    //
    // The request was rejected because the specified grant token is not valid.
    ErrCodeInvalidGrantTokenException = "InvalidGrantTokenException"

    // ErrCodeInvalidImportTokenException for service response error code
    // "InvalidImportTokenException".
    //
    // The request was rejected because the provided import token is invalid or
    // is associated with a different customer master key (CMK).
    ErrCodeInvalidImportTokenException = "InvalidImportTokenException"

    // ErrCodeInvalidKeyUsageException for service response error code
    // "InvalidKeyUsageException".
    //
    // The request was rejected for one of the following reasons:
    //
    //    * The KeyUsage value of the CMK 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 CMK (CustomerMasterKeySpec).
    //
    // For encrypting, decrypting, re-encrypting, and generating data keys, the
    // KeyUsage must be ENCRYPT_DECRYPT. For signing and verifying, the KeyUsage
    // must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation.
    //
    // To find the encryption or signing algorithms supported for a particular CMK,
    // use the DescribeKey operation.
    ErrCodeInvalidKeyUsageException = "InvalidKeyUsageException"

    // ErrCodeInvalidMarkerException for service response error code
    // "InvalidMarkerException".
    //
    // The request was rejected because the marker that specifies where pagination
    // should next begin is not valid.
    ErrCodeInvalidMarkerException = "InvalidMarkerException"

    // ErrCodeInvalidStateException for service response error code
    // "KMSInvalidStateException".
    //
    // The request was rejected because the state of the specified resource is not
    // valid for this request.
    //
    // For more information about how key state affects the use of a CMK, see How
    // Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html)
    // in the AWS Key Management Service Developer Guide .
    ErrCodeInvalidStateException = "KMSInvalidStateException"

    // ErrCodeKMSInvalidSignatureException for service response error code
    // "KMSInvalidSignatureException".
    //
    // The request was rejected because the signature verification failed. Signature
    // verification fails when it cannot confirm that signature was produced by
    // signing the specified message with the specified CMK and signing algorithm.
    ErrCodeKMSInvalidSignatureException = "KMSInvalidSignatureException"

    // ErrCodeKeyUnavailableException for service response error code
    // "KeyUnavailableException".
    //
    // The request was rejected because the specified CMK was not available. You
    // can retry the request.
    ErrCodeKeyUnavailableException = "KeyUnavailableException"

    // ErrCodeLimitExceededException for service response error code
    // "LimitExceededException".
    //
    // The request was rejected because a quota was exceeded. For more information,
    // see Quotas (https://docs.aws.amazon.com/kms/latest/developerguide/limits.html)
    // in the AWS Key Management Service Developer Guide.
    ErrCodeLimitExceededException = "LimitExceededException"

    // ErrCodeMalformedPolicyDocumentException for service response error code
    // "MalformedPolicyDocumentException".
    //
    // The request was rejected because the specified policy is not syntactically
    // or semantically correct.
    ErrCodeMalformedPolicyDocumentException = "MalformedPolicyDocumentException"

    // ErrCodeNotFoundException for service response error code
    // "NotFoundException".
    //
    // The request was rejected because the specified entity or resource could not
    // be found.
    ErrCodeNotFoundException = "NotFoundException"

    // ErrCodeTagException for service response error code
    // "TagException".
    //
    // The request was rejected because one or more tags are not valid.
    ErrCodeTagException = "TagException"

    // ErrCodeUnsupportedOperationException for service response error code
    // "UnsupportedOperationException".
    //
    // The request was rejected because a specified parameter is not supported or
    // a specified resource is not valid for this operation.
    ErrCodeUnsupportedOperationException = "UnsupportedOperationException"
)
const (
    ServiceName = "kms"       // Name of service.
    EndpointsID = ServiceName // ID to lookup a service endpoint with.
    ServiceID   = "KMS"       // ServiceID is a unique identifier of a specific service.
)

Service information constants

const (
    // WrappingKeySpecRsa2048 is a WrappingKeySpec enum value
    WrappingKeySpecRsa2048 = "RSA_2048"
)

func AlgorithmSpec_Values

func AlgorithmSpec_Values() []string

AlgorithmSpec_Values returns all elements of the AlgorithmSpec enum

func ConnectionErrorCodeType_Values

func ConnectionErrorCodeType_Values() []string

ConnectionErrorCodeType_Values returns all elements of the ConnectionErrorCodeType enum

func ConnectionStateType_Values

func ConnectionStateType_Values() []string

ConnectionStateType_Values returns all elements of the ConnectionStateType enum

func CustomerMasterKeySpec_Values

func CustomerMasterKeySpec_Values() []string

CustomerMasterKeySpec_Values returns all elements of the CustomerMasterKeySpec enum

func DataKeyPairSpec_Values

func DataKeyPairSpec_Values() []string

DataKeyPairSpec_Values returns all elements of the DataKeyPairSpec enum

func DataKeySpec_Values

func DataKeySpec_Values() []string

DataKeySpec_Values returns all elements of the DataKeySpec enum

func EncryptionAlgorithmSpec_Values

func EncryptionAlgorithmSpec_Values() []string

EncryptionAlgorithmSpec_Values returns all elements of the EncryptionAlgorithmSpec enum

func ExpirationModelType_Values

func ExpirationModelType_Values() []string

ExpirationModelType_Values returns all elements of the ExpirationModelType enum

func GrantOperation_Values

func GrantOperation_Values() []string

GrantOperation_Values returns all elements of the GrantOperation enum

func KeyManagerType_Values

func KeyManagerType_Values() []string

KeyManagerType_Values returns all elements of the KeyManagerType enum

func KeyState_Values

func KeyState_Values() []string

KeyState_Values returns all elements of the KeyState enum

func KeyUsageType_Values

func KeyUsageType_Values() []string

KeyUsageType_Values returns all elements of the KeyUsageType enum

func MessageType_Values

func MessageType_Values() []string

MessageType_Values returns all elements of the MessageType enum

func OriginType_Values

func OriginType_Values() []string

OriginType_Values returns all elements of the OriginType enum

func SigningAlgorithmSpec_Values

func SigningAlgorithmSpec_Values() []string

SigningAlgorithmSpec_Values returns all elements of the SigningAlgorithmSpec enum

func WrappingKeySpec_Values

func WrappingKeySpec_Values() []string

WrappingKeySpec_Values returns all elements of the WrappingKeySpec enum

type AliasListEntry

type AliasListEntry struct {

    // String that contains the key ARN.
    AliasArn *string `min:"20" type:"string"`

    // String that contains the alias. This value begins with alias/.
    AliasName *string `min:"1" type:"string"`

    // String that contains the key identifier referred to by the alias.
    TargetKeyId *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

Contains information about an alias.

func (AliasListEntry) GoString

func (s AliasListEntry) GoString() string

GoString returns the string representation

func (*AliasListEntry) SetAliasArn

func (s *AliasListEntry) SetAliasArn(v string) *AliasListEntry

SetAliasArn sets the AliasArn field's value.

func (*AliasListEntry) SetAliasName

func (s *AliasListEntry) SetAliasName(v string) *AliasListEntry

SetAliasName sets the AliasName field's value.

func (*AliasListEntry) SetTargetKeyId

func (s *AliasListEntry) SetTargetKeyId(v string) *AliasListEntry

SetTargetKeyId sets the TargetKeyId field's value.

func (AliasListEntry) String

func (s AliasListEntry) String() string

String returns the string representation

type AlreadyExistsException

type AlreadyExistsException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

The request was rejected because it attempted to create a resource that already exists.

func (*AlreadyExistsException) Code

func (s *AlreadyExistsException) Code() string

Code returns the exception type name.

func (*AlreadyExistsException) Error

func (s *AlreadyExistsException) Error() string

func (AlreadyExistsException) GoString

func (s AlreadyExistsException) GoString() string

GoString returns the string representation

func (*AlreadyExistsException) Message

func (s *AlreadyExistsException) Message() string

Message returns the exception's message.

func (*AlreadyExistsException) OrigErr

func (s *AlreadyExistsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AlreadyExistsException) RequestID

func (s *AlreadyExistsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AlreadyExistsException) StatusCode

func (s *AlreadyExistsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AlreadyExistsException) String

func (s AlreadyExistsException) String() string

String returns the string representation

type CancelKeyDeletionInput

type CancelKeyDeletionInput struct {

    // The unique identifier for the customer master key (CMK) for which to cancel
    // deletion.
    //
    // Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
    //
    // For example:
    //
    //    * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    //
    //    * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    //
    // To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
    //
    // KeyId is a required field
    KeyId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (CancelKeyDeletionInput) GoString

func (s CancelKeyDeletionInput) GoString() string

GoString returns the string representation

func (*CancelKeyDeletionInput) SetKeyId

func (s *CancelKeyDeletionInput) SetKeyId(v string) *CancelKeyDeletionInput

SetKeyId sets the KeyId field's value.

func (CancelKeyDeletionInput) String

func (s CancelKeyDeletionInput) String() string

String returns the string representation

func (*CancelKeyDeletionInput) Validate

func (s *CancelKeyDeletionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CancelKeyDeletionOutput

type CancelKeyDeletionOutput struct {

    // The Amazon Resource Name (key ARN (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN))
    // of the CMK whose deletion is canceled.
    KeyId *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (CancelKeyDeletionOutput) GoString

func (s CancelKeyDeletionOutput) GoString() string

GoString returns the string representation

func (*CancelKeyDeletionOutput) SetKeyId

func (s *CancelKeyDeletionOutput) SetKeyId(v string) *CancelKeyDeletionOutput

SetKeyId sets the KeyId field's value.

func (CancelKeyDeletionOutput) String

func (s CancelKeyDeletionOutput) String() string

String returns the string representation

type CloudHsmClusterInUseException

type CloudHsmClusterInUseException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

The request was rejected because the specified AWS CloudHSM cluster is already associated with a custom key store or it shares a backup history with a cluster that is associated with a custom key store. Each custom key store must be associated with a different AWS CloudHSM cluster.

Clusters that share a backup history have the same cluster certificate. To view the cluster certificate of a cluster, use the DescribeClusters (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html) operation.

func (*CloudHsmClusterInUseException) Code

func (s *CloudHsmClusterInUseException) Code() string

Code returns the exception type name.

func (*CloudHsmClusterInUseException) Error

func (s *CloudHsmClusterInUseException) Error() string

func (CloudHsmClusterInUseException) GoString

func (s CloudHsmClusterInUseException) GoString() string

GoString returns the string representation

func (*CloudHsmClusterInUseException) Message

func (s *CloudHsmClusterInUseException) Message() string

Message returns the exception's message.

func (*CloudHsmClusterInUseException) OrigErr

func (s *CloudHsmClusterInUseException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*CloudHsmClusterInUseException) RequestID

func (s *CloudHsmClusterInUseException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*CloudHsmClusterInUseException) StatusCode

func (s *CloudHsmClusterInUseException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (CloudHsmClusterInUseException) String

func (s CloudHsmClusterInUseException) String() string

String returns the string representation

type CloudHsmClusterInvalidConfigurationException

type CloudHsmClusterInvalidConfigurationException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

The request was rejected because the associated AWS CloudHSM cluster did not meet the configuration requirements for a custom key store.

* The cluster must be configured with private subnets in at least two
different Availability Zones in the Region.

* The security group for the cluster (https://docs.aws.amazon.com/cloudhsm/latest/userguide/configure-sg.html)
(cloudhsm-cluster-<cluster-id>-sg) must include inbound rules and outbound
rules that allow TCP traffic on ports 2223-2225. The Source in the inbound
rules and the Destination in the outbound rules must match the security
group ID. These rules are set by default when you create the cluster.
Do not delete or change them. To get information about a particular security
group, use the DescribeSecurityGroups (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSecurityGroups.html)
operation.

* The cluster must contain at least as many HSMs as the operation requires.
To add HSMs, use the AWS CloudHSM CreateHsm (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_CreateHsm.html)
operation. For the CreateCustomKeyStore, UpdateCustomKeyStore, and CreateKey
operations, the AWS CloudHSM cluster must have at least two active HSMs,
each in a different Availability Zone. For the ConnectCustomKeyStore operation,
the AWS CloudHSM must contain at least one active HSM.

For information about the requirements for an AWS CloudHSM cluster that is associated with a custom key store, see Assemble the Prerequisites (https://docs.aws.amazon.com/kms/latest/developerguide/create-keystore.html#before-keystore) in the AWS Key Management Service Developer Guide. For information about creating a private subnet for an AWS CloudHSM cluster, see Create a Private Subnet (https://docs.aws.amazon.com/cloudhsm/latest/userguide/create-subnets.html) in the AWS CloudHSM User Guide. For information about cluster security groups, see Configure a Default Security Group (https://docs.aws.amazon.com/cloudhsm/latest/userguide/configure-sg.html) in the AWS CloudHSM User Guide .

func (*CloudHsmClusterInvalidConfigurationException) Code

func (s *CloudHsmClusterInvalidConfigurationException) Code() string

Code returns the exception type name.

func (*CloudHsmClusterInvalidConfigurationException) Error

func (s *CloudHsmClusterInvalidConfigurationException) Error() string

func (CloudHsmClusterInvalidConfigurationException) GoString

func (s CloudHsmClusterInvalidConfigurationException) GoString() string

GoString returns the string representation

func (*CloudHsmClusterInvalidConfigurationException) Message

func (s *CloudHsmClusterInvalidConfigurationException) Message() string

Message returns the exception's message.

func (*CloudHsmClusterInvalidConfigurationException) OrigErr

func (s *CloudHsmClusterInvalidConfigurationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*CloudHsmClusterInvalidConfigurationException) RequestID

func (s *CloudHsmClusterInvalidConfigurationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*CloudHsmClusterInvalidConfigurationException) StatusCode

func (s *CloudHsmClusterInvalidConfigurationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (CloudHsmClusterInvalidConfigurationException) String

func (s CloudHsmClusterInvalidConfigurationException) String() string

String returns the string representation

type CloudHsmClusterNotActiveException

type CloudHsmClusterNotActiveException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

The request was rejected because the AWS CloudHSM cluster that is associated with the custom key store is not active. Initialize and activate the cluster and try the command again. For detailed instructions, see Getting Started (https://docs.aws.amazon.com/cloudhsm/latest/userguide/getting-started.html) in the AWS CloudHSM User Guide.

func (*CloudHsmClusterNotActiveException) Code

func (s *CloudHsmClusterNotActiveException) Code() string

Code returns the exception type name.

func (*CloudHsmClusterNotActiveException) Error

func (s *CloudHsmClusterNotActiveException) Error() string

func (CloudHsmClusterNotActiveException) GoString

func (s CloudHsmClusterNotActiveException) GoString() string

GoString returns the string representation

func (*CloudHsmClusterNotActiveException) Message

func (s *CloudHsmClusterNotActiveException) Message() string

Message returns the exception's message.

func (*CloudHsmClusterNotActiveException) OrigErr

func (s *CloudHsmClusterNotActiveException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*CloudHsmClusterNotActiveException) RequestID

func (s *CloudHsmClusterNotActiveException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*CloudHsmClusterNotActiveException) StatusCode

func (s *CloudHsmClusterNotActiveException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (CloudHsmClusterNotActiveException) String

func (s CloudHsmClusterNotActiveException) String() string

String returns the string representation

type CloudHsmClusterNotFoundException

type CloudHsmClusterNotFoundException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

The request was rejected because AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID. Retry the request with a different cluster ID.

func (*CloudHsmClusterNotFoundException) Code

func (s *CloudHsmClusterNotFoundException) Code() string

Code returns the exception type name.

func (*CloudHsmClusterNotFoundException) Error

func (s *CloudHsmClusterNotFoundException) Error() string

func (CloudHsmClusterNotFoundException) GoString

func (s CloudHsmClusterNotFoundException) GoString() string

GoString returns the string representation

func (*CloudHsmClusterNotFoundException) Message

func (s *CloudHsmClusterNotFoundException) Message() string

Message returns the exception's message.

func (*CloudHsmClusterNotFoundException) OrigErr

func (s *CloudHsmClusterNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*CloudHsmClusterNotFoundException) RequestID

func (s *CloudHsmClusterNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*CloudHsmClusterNotFoundException) StatusCode

func (s *CloudHsmClusterNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (CloudHsmClusterNotFoundException) String

func (s CloudHsmClusterNotFoundException) String() string

String returns the string representation

type CloudHsmClusterNotRelatedException

type CloudHsmClusterNotRelatedException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

The request was rejected because the specified AWS CloudHSM cluster has a different cluster certificate than the original cluster. You cannot use the operation to specify an unrelated cluster.

Specify a cluster that shares a backup history with the original cluster. This includes clusters that were created from a backup of the current cluster, and clusters that were created from the same backup that produced the current cluster.

Clusters that share a backup history have the same cluster certificate. To view the cluster certificate of a cluster, use the DescribeClusters (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html) operation.

func (*CloudHsmClusterNotRelatedException) Code

func (s *CloudHsmClusterNotRelatedException) Code() string

Code returns the exception type name.

func (*CloudHsmClusterNotRelatedException) Error

func (s *CloudHsmClusterNotRelatedException) Error() string

func (CloudHsmClusterNotRelatedException) GoString

func (s CloudHsmClusterNotRelatedException) GoString() string

GoString returns the string representation

func (*CloudHsmClusterNotRelatedException) Message

func (s *CloudHsmClusterNotRelatedException) Message() string

Message returns the exception's message.

func (*CloudHsmClusterNotRelatedException) OrigErr

func (s *CloudHsmClusterNotRelatedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*CloudHsmClusterNotRelatedException) RequestID

func (s *CloudHsmClusterNotRelatedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*CloudHsmClusterNotRelatedException) StatusCode

func (s *CloudHsmClusterNotRelatedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (CloudHsmClusterNotRelatedException) String

func (s CloudHsmClusterNotRelatedException) String() string

String returns the string representation

type ConnectCustomKeyStoreInput

type ConnectCustomKeyStoreInput struct {

    // Enter the key store ID of the custom key store that you want to connect.
    // To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
    //
    // CustomKeyStoreId is a required field
    CustomKeyStoreId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (ConnectCustomKeyStoreInput) GoString

func (s ConnectCustomKeyStoreInput) GoString() string

GoString returns the string representation

func (*ConnectCustomKeyStoreInput) SetCustomKeyStoreId

func (s *ConnectCustomKeyStoreInput) SetCustomKeyStoreId(v string) *ConnectCustomKeyStoreInput

SetCustomKeyStoreId sets the CustomKeyStoreId field's value.

func (ConnectCustomKeyStoreInput) String

func (s ConnectCustomKeyStoreInput) String() string

String returns the string representation

func (*ConnectCustomKeyStoreInput) Validate

func (s *ConnectCustomKeyStoreInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ConnectCustomKeyStoreOutput

type ConnectCustomKeyStoreOutput struct {
    // contains filtered or unexported fields
}

func (ConnectCustomKeyStoreOutput) GoString

func (s ConnectCustomKeyStoreOutput) GoString() string

GoString returns the string representation

func (ConnectCustomKeyStoreOutput) String

func (s ConnectCustomKeyStoreOutput) String() string

String returns the string representation

type CreateAliasInput

type CreateAliasInput struct {

    // Specifies the alias name. This value must begin with alias/ followed by a
    // name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/.
    // The alias/aws/ prefix is reserved for AWS managed CMKs.
    //
    // AliasName is a required field
    AliasName *string `min:"1" type:"string" required:"true"`

    // Identifies the CMK to which the alias refers. Specify the key ID or the Amazon
    // Resource Name (ARN) of the CMK. You cannot specify another alias. For help
    // finding the key ID and ARN, see Finding the Key ID and ARN (https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn)
    // in the AWS Key Management Service Developer Guide.
    //
    // TargetKeyId is a required field
    TargetKeyId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (CreateAliasInput) GoString

func (s CreateAliasInput) GoString() string

GoString returns the string representation

func (*CreateAliasInput) SetAliasName

func (s *CreateAliasInput) SetAliasName(v string) *CreateAliasInput

SetAliasName sets the AliasName field's value.

func (*CreateAliasInput) SetTargetKeyId

func (s *CreateAliasInput) SetTargetKeyId(v string) *CreateAliasInput

SetTargetKeyId sets the TargetKeyId field's value.

func (CreateAliasInput) String

func (s CreateAliasInput) String() string

String returns the string representation

func (*CreateAliasInput) Validate

func (s *CreateAliasInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateAliasOutput

type CreateAliasOutput struct {
    // contains filtered or unexported fields
}

func (CreateAliasOutput) GoString

func (s CreateAliasOutput) GoString() string

GoString returns the string representation

func (CreateAliasOutput) String

func (s CreateAliasOutput) String() string

String returns the string representation

type CreateCustomKeyStoreInput

type CreateCustomKeyStoreInput struct {

    // Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster
    // ID of any active AWS CloudHSM cluster that is not already associated with
    // a custom key store. To find the cluster ID, use the DescribeClusters (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html)
    // operation.
    //
    // CloudHsmClusterId is a required field
    CloudHsmClusterId *string `min:"19" type:"string" required:"true"`

    // Specifies a friendly name for the custom key store. The name must be unique
    // in your AWS account.
    //
    // CustomKeyStoreName is a required field
    CustomKeyStoreName *string `min:"1" type:"string" required:"true"`

    // Enter the password of the kmsuser crypto user (CU) account (https://docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-kmsuser)
    // in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this
    // user to manage key material on your behalf.
    //
    // The password must be a string of 7 to 32 characters. Its value is case sensitive.
    //
    // This parameter tells AWS KMS the kmsuser account password; it does not change
    // the password in the AWS CloudHSM cluster.
    //
    // KeyStorePassword is a required field
    KeyStorePassword *string `min:"7" type:"string" required:"true" sensitive:"true"`

    // Enter the content of the trust anchor certificate for the cluster. This is
    // the content of the customerCA.crt file that you created when you initialized
    // the cluster (https://docs.aws.amazon.com/cloudhsm/latest/userguide/initialize-cluster.html).
    //
    // TrustAnchorCertificate is a required field
    TrustAnchorCertificate *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (CreateCustomKeyStoreInput) GoString

func (s CreateCustomKeyStoreInput) GoString() string

GoString returns the string representation

func (*CreateCustomKeyStoreInput) SetCloudHsmClusterId

func (s *CreateCustomKeyStoreInput) SetCloudHsmClusterId(v string) *CreateCustomKeyStoreInput

SetCloudHsmClusterId sets the CloudHsmClusterId field's value.

func (*CreateCustomKeyStoreInput) SetCustomKeyStoreName

func (s *CreateCustomKeyStoreInput) SetCustomKeyStoreName(v string) *CreateCustomKeyStoreInput

SetCustomKeyStoreName sets the CustomKeyStoreName field's value.

func (*CreateCustomKeyStoreInput) SetKeyStorePassword

func (s *CreateCustomKeyStoreInput) SetKeyStorePassword(v string) *CreateCustomKeyStoreInput

SetKeyStorePassword sets the KeyStorePassword field's value.

func (*CreateCustomKeyStoreInput) SetTrustAnchorCertificate

func (s *CreateCustomKeyStoreInput) SetTrustAnchorCertificate(v string) *CreateCustomKeyStoreInput

SetTrustAnchorCertificate sets the TrustAnchorCertificate field's value.

func (CreateCustomKeyStoreInput) String

func (s CreateCustomKeyStoreInput) String() string

String returns the string representation

func (*CreateCustomKeyStoreInput) Validate

func (s *CreateCustomKeyStoreInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateCustomKeyStoreOutput

type CreateCustomKeyStoreOutput struct {

    // A unique identifier for the new custom key store.
    CustomKeyStoreId *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (CreateCustomKeyStoreOutput) GoString

func (s CreateCustomKeyStoreOutput) GoString() string

GoString returns the string representation

func (*CreateCustomKeyStoreOutput) SetCustomKeyStoreId

func (s *CreateCustomKeyStoreOutput) SetCustomKeyStoreId(v string) *CreateCustomKeyStoreOutput

SetCustomKeyStoreId sets the CustomKeyStoreId field's value.

func (CreateCustomKeyStoreOutput) String

func (s CreateCustomKeyStoreOutput) String() string

String returns the string representation

type CreateGrantInput

type CreateGrantInput struct {

    // Allows a cryptographic operation (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations)
    // only when the encryption context matches or includes the encryption context
    // specified in this structure. For more information about encryption context,
    // see Encryption Context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context)
    // in the AWS Key Management Service Developer Guide .
    Constraints *GrantConstraints `type:"structure"`

    // A list of grant tokens.
    //
    // For more information, see Grant Tokens (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token)
    // in the AWS Key Management Service Developer Guide.
    GrantTokens []*string `type:"list"`

    // The principal that is given permission to perform the operations that the
    // grant permits.
    //
    // To specify the principal, use the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
    // of an AWS principal. Valid AWS principals include AWS accounts (root), IAM
    // users, IAM roles, federated users, and assumed role users. For examples of
    // the ARN syntax to use for specifying a principal, see AWS Identity and Access
    // Management (IAM) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam)
    // in the Example ARNs section of the AWS General Reference.
    //
    // GranteePrincipal is a required field
    GranteePrincipal *string `min:"1" type:"string" required:"true"`

    // The unique identifier for the customer master key (CMK) that the grant applies
    // to.
    //
    // Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify
    // a CMK in a different AWS account, you must use the key ARN.
    //
    // For example:
    //
    //    * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    //
    //    * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    //
    // To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
    //
    // KeyId is a required field
    KeyId *string `min:"1" type:"string" required:"true"`

    // A friendly name for identifying the grant. Use this value to prevent the
    // unintended creation of duplicate grants when retrying this request.
    //
    // When this value is absent, all CreateGrant requests result in a new grant
    // with a unique GrantId even if all the supplied parameters are identical.
    // This can result in unintended duplicates when you retry the CreateGrant request.
    //
    // When this value is present, you can retry a CreateGrant request with identical
    // parameters; if the grant already exists, the original GrantId is returned
    // without creating a new grant. Note that the returned grant token is unique
    // with every CreateGrant request, even when a duplicate GrantId is returned.
    // All grant tokens obtained in this way can be used interchangeably.
    Name *string `min:"1" type:"string"`

    // A list of operations that the grant permits.
    //
    // Operations is a required field
    Operations []*string `type:"list" required:"true"`

    // The principal that is given permission to retire the grant by using RetireGrant
    // operation.
    //
    // To specify the principal, use the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
    // of an AWS principal. Valid AWS principals include AWS accounts (root), IAM
    // users, federated users, and assumed role users. For examples of the ARN syntax
    // to use for specifying a principal, see AWS Identity and Access Management
    // (IAM) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam)
    // in the Example ARNs section of the AWS General Reference.
    RetiringPrincipal *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (CreateGrantInput) GoString

func (s CreateGrantInput) GoString() string

GoString returns the string representation

func (*CreateGrantInput) SetConstraints

func (s *CreateGrantInput) SetConstraints(v *GrantConstraints) *CreateGrantInput

SetConstraints sets the Constraints field's value.

func (*CreateGrantInput) SetGrantTokens

func (s *CreateGrantInput) SetGrantTokens(v []*string) *CreateGrantInput

SetGrantTokens sets the GrantTokens field's value.

func (*CreateGrantInput) SetGranteePrincipal

func (s *CreateGrantInput) SetGranteePrincipal(v string) *CreateGrantInput

SetGranteePrincipal sets the GranteePrincipal field's value.

func (*CreateGrantInput) SetKeyId

func (s *CreateGrantInput) SetKeyId(v string) *CreateGrantInput

SetKeyId sets the KeyId field's value.

func (*CreateGrantInput) SetName

func (s *CreateGrantInput) SetName(v string) *CreateGrantInput

SetName sets the Name field's value.

func (*CreateGrantInput) SetOperations

func (s *CreateGrantInput) SetOperations(v []*string) *CreateGrantInput

SetOperations sets the Operations field's value.

func (*CreateGrantInput) SetRetiringPrincipal

func (s *CreateGrantInput) SetRetiringPrincipal(v string) *CreateGrantInput

SetRetiringPrincipal sets the RetiringPrincipal field's value.

func (CreateGrantInput) String

func (s CreateGrantInput) String() string

String returns the string representation

func (*CreateGrantInput) Validate

func (s *CreateGrantInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateGrantOutput

type CreateGrantOutput struct {

    // The unique identifier for the grant.
    //
    // You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.
    GrantId *string `min:"1" type:"string"`

    // The grant token.
    //
    // For more information, see Grant Tokens (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token)
    // in the AWS Key Management Service Developer Guide.
    GrantToken *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (CreateGrantOutput) GoString

func (s CreateGrantOutput) GoString() string

GoString returns the string representation

func (*CreateGrantOutput) SetGrantId

func (s *CreateGrantOutput) SetGrantId(v string) *CreateGrantOutput

SetGrantId sets the GrantId field's value.

func (*CreateGrantOutput) SetGrantToken

func (s *CreateGrantOutput) SetGrantToken(v string) *CreateGrantOutput

SetGrantToken sets the GrantToken field's value.

func (CreateGrantOutput) String

func (s CreateGrantOutput) String() string

String returns the string representation

type CreateKeyInput

type CreateKeyInput struct {

    // A flag to indicate whether to bypass the key policy lockout safety check.
    //
    // Setting this value to true increases the risk that the CMK becomes unmanageable.
    // Do not set this value to true indiscriminately.
    //
    // For more information, refer to the scenario in the Default Key Policy (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam)
    // section in the AWS Key Management Service Developer Guide .
    //
    // Use this parameter only when you include a policy in the request and you
    // intend to prevent the principal that is making the request from making a
    // subsequent PutKeyPolicy request on the CMK.
    //
    // The default value is false.
    BypassPolicyLockoutSafetyCheck *bool `type:"boolean"`

    // Creates the CMK in the specified custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html)
    // and the key material in its associated AWS CloudHSM cluster. To create a
    // CMK in a custom key store, you must also specify the Origin parameter with
    // a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with
    // the custom key store must have at least two active HSMs, each in a different
    // Availability Zone in the Region.
    //
    // This parameter is valid only for symmetric CMKs. You cannot create an asymmetric
    // CMK in a custom key store.
    //
    // To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
    //
    // The response includes the custom key store ID and the ID of the AWS CloudHSM
    // cluster.
    //
    // This operation is part of the Custom Key Store feature (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html)
    // feature in AWS KMS, which combines the convenience and extensive integration
    // of AWS KMS with the isolation and control of a single-tenant key store.
    CustomKeyStoreId *string `min:"1" type:"string"`

    // Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT,
    // creates a CMK with a 256-bit symmetric key for encryption and decryption.
    // For help choosing a key spec for your CMK, see How to Choose Your CMK Configuration
    // (https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-choose.html)
    // in the AWS Key Management Service Developer Guide.
    //
    // The CustomerMasterKeySpec determines whether the CMK contains a symmetric
    // key or an asymmetric key pair. It also determines the encryption algorithms
    // or signing algorithms that the CMK supports. You can't change the CustomerMasterKeySpec
    // after the CMK is created. To further restrict the algorithms that can be
    // used with the CMK, use a condition key in its key policy or IAM policy. For
    // more information, see kms:EncryptionAlgorithm (https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-encryption-algorithm)
    // or kms:Signing Algorithm (https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-signing-algorithm)
    // in the AWS Key Management Service Developer Guide.
    //
    // AWS services that are integrated with AWS KMS (http://aws.amazon.com/kms/features/#AWS_Service_Integration)
    // use symmetric CMKs to protect your data. These services do not support asymmetric
    // CMKs. For help determining whether a CMK is symmetric or asymmetric, see
    // Identifying Symmetric and Asymmetric CMKs (https://docs.aws.amazon.com/kms/latest/developerguide/find-symm-asymm.html)
    // in the AWS Key Management Service Developer Guide.
    //
    // AWS KMS supports the following key specs for CMKs:
    //
    //    * Symmetric key (default) SYMMETRIC_DEFAULT (AES-256-GCM)
    //
    //    * Asymmetric RSA key pairs RSA_2048 RSA_3072 RSA_4096
    //
    //    * Asymmetric NIST-recommended elliptic curve key pairs ECC_NIST_P256 (secp256r1)
    //    ECC_NIST_P384 (secp384r1) ECC_NIST_P521 (secp521r1)
    //
    //    * Other asymmetric elliptic curve key pairs ECC_SECG_P256K1 (secp256k1),
    //    commonly used for cryptocurrencies.
    CustomerMasterKeySpec *string `type:"string" enum:"CustomerMasterKeySpec"`

    // A description of the CMK.
    //
    // Use a description that helps you decide whether the CMK is appropriate for
    // a task.
    Description *string `type:"string"`

    // Determines the cryptographic operations (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations)
    // for which you can use the CMK. The default value is ENCRYPT_DECRYPT. This
    // parameter is required only for asymmetric CMKs. You can't change the KeyUsage
    // value after the CMK is created.
    //
    // Select only one valid value.
    //
    //    * For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
    //
    //    * For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or
    //    SIGN_VERIFY.
    //
    //    * For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
    KeyUsage *string `type:"string" enum:"KeyUsageType"`

    // The source of the key material for the CMK. You cannot change the origin
    // after you create the CMK. The default is AWS_KMS, which means AWS KMS creates
    // the key material.
    //
    // When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material
    // so that you can import key material from your existing key management infrastructure.
    // For more information about importing key material into AWS KMS, see Importing
    // Key Material (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html)
    // in the AWS Key Management Service Developer Guide. This value is valid only
    // for symmetric CMKs.
    //
    // When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS
    // KMS custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html)
    // and creates its key material in the associated AWS CloudHSM cluster. You
    // must also use the CustomKeyStoreId parameter to identify the custom key store.
    // This value is valid only for symmetric CMKs.
    Origin *string `type:"string" enum:"OriginType"`

    // The key policy to attach to the CMK.
    //
    // If you provide a key policy, it must meet the following criteria:
    //
    //    * If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy
    //    must allow the principal that is making the CreateKey request to make
    //    a subsequent PutKeyPolicy request on the CMK. This reduces the risk that
    //    the CMK becomes unmanageable. For more information, refer to the scenario
    //    in the Default Key Policy (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam)
    //    section of the AWS Key Management Service Developer Guide .
    //
    //    * Each statement in the key policy must contain one or more principals.
    //    The principals in the key policy must exist and be visible to AWS KMS.
    //    When you create a new AWS principal (for example, an IAM user or role),
    //    you might need to enforce a delay before including the new principal in
    //    a key policy because the new principal might not be immediately visible
    //    to AWS KMS. For more information, see Changes that I make are not always
    //    immediately visible (https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency)
    //    in the AWS Identity and Access Management User Guide.
    //
    // If you do not provide a key policy, AWS KMS attaches a default key policy
    // to the CMK. For more information, see Default Key Policy (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default)
    // in the AWS Key Management Service Developer Guide.
    //
    // The key policy size quota is 32 kilobytes (32768 bytes).
    Policy *string `min:"1" type:"string"`

    // One or more tags. Each tag consists of a tag key and a tag value. Both the
    // tag key and the tag value are required, but the tag value can be an empty
    // (null) string.
    //
    // When you add tags to an AWS resource, AWS generates a cost allocation report
    // with usage and costs aggregated by tags. For information about adding, changing,
    // deleting and listing tags for CMKs, see Tagging Keys (https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html).
    //
    // Use this parameter to tag the CMK when it is created. To add tags to an existing
    // CMK, use the TagResource operation.
    Tags []*Tag `type:"list"`
    // contains filtered or unexported fields
}

func (CreateKeyInput) GoString

func (s CreateKeyInput) GoString() string

GoString returns the string representation

func (*CreateKeyInput) SetBypassPolicyLockoutSafetyCheck

func (s *CreateKeyInput) SetBypassPolicyLockoutSafetyCheck(v bool) *CreateKeyInput

SetBypassPolicyLockoutSafetyCheck sets the BypassPolicyLockoutSafetyCheck field's value.

func (*CreateKeyInput) SetCustomKeyStoreId

func (s *CreateKeyInput) SetCustomKeyStoreId(v string) *CreateKeyInput

SetCustomKeyStoreId sets the CustomKeyStoreId field's value.

func (*CreateKeyInput) SetCustomerMasterKeySpec

func (s *CreateKeyInput) SetCustomerMasterKeySpec(v string) *CreateKeyInput

SetCustomerMasterKeySpec sets the CustomerMasterKeySpec field's value.

func (*CreateKeyInput) SetDescription

func (s *CreateKeyInput) SetDescription(v string) *CreateKeyInput

SetDescription sets the Description field's value.

func (*CreateKeyInput) SetKeyUsage

func (s *CreateKeyInput) SetKeyUsage(v string) *CreateKeyInput

SetKeyUsage sets the KeyUsage field's value.

func (*CreateKeyInput) SetOrigin

func (s *CreateKeyInput) SetOrigin(v string) *CreateKeyInput

SetOrigin sets the Origin field's value.

func (*CreateKeyInput) SetPolicy

func (s *CreateKeyInput) SetPolicy(v string) *CreateKeyInput

SetPolicy sets the Policy field's value.

func (*CreateKeyInput) SetTags

func (s *CreateKeyInput) SetTags(v []*Tag) *CreateKeyInput

SetTags sets the Tags field's value.

func (CreateKeyInput) String

func (s CreateKeyInput) String() string

String returns the string representation

func (*CreateKeyInput) Validate

func (s *CreateKeyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateKeyOutput

type CreateKeyOutput struct {

    // Metadata associated with the CMK.
    KeyMetadata *KeyMetadata `type:"structure"`
    // contains filtered or unexported fields
}

func (CreateKeyOutput) GoString

func (s CreateKeyOutput) GoString() string

GoString returns the string representation

func (*CreateKeyOutput) SetKeyMetadata

func (s *CreateKeyOutput) SetKeyMetadata(v *KeyMetadata) *CreateKeyOutput

SetKeyMetadata sets the KeyMetadata field's value.

func (CreateKeyOutput) String

func (s CreateKeyOutput) String() string

String returns the string representation

type CustomKeyStoreHasCMKsException

type CustomKeyStoreHasCMKsException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

The request was rejected because the custom key store contains AWS KMS customer master keys (CMKs). After verifying that you do not need to use the CMKs, use the ScheduleKeyDeletion operation to delete the CMKs. After they are deleted, you can delete the custom key store.

func (*CustomKeyStoreHasCMKsException) Code

func (s *CustomKeyStoreHasCMKsException) Code() string

Code returns the exception type name.

func (*CustomKeyStoreHasCMKsException) Error

func (s *CustomKeyStoreHasCMKsException) Error() string

func (CustomKeyStoreHasCMKsException) GoString

func (s CustomKeyStoreHasCMKsException) GoString() string

GoString returns the string representation

func (*CustomKeyStoreHasCMKsException) Message

func (s *CustomKeyStoreHasCMKsException) Message() string

Message returns the exception's message.

func (*CustomKeyStoreHasCMKsException) OrigErr

func (s *CustomKeyStoreHasCMKsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*CustomKeyStoreHasCMKsException) RequestID

func (s *CustomKeyStoreHasCMKsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*CustomKeyStoreHasCMKsException) StatusCode

func (s *CustomKeyStoreHasCMKsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (CustomKeyStoreHasCMKsException) String

func (s CustomKeyStoreHasCMKsException) String() string

String returns the string representation

type CustomKeyStoreInvalidStateException

type CustomKeyStoreInvalidStateException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

The request was rejected because of the ConnectionState of the custom key store. To get the ConnectionState of a custom key store, use the DescribeCustomKeyStores operation.

This exception is thrown under the following conditions:

* You requested the CreateKey or GenerateRandom operation in a custom
key store that is not connected. These operations are valid only when
the custom key store ConnectionState is CONNECTED.

* You requested the UpdateCustomKeyStore or DeleteCustomKeyStore operation
on a custom key store that is not disconnected. This operation is valid
only when the custom key store ConnectionState is DISCONNECTED.

* You requested the ConnectCustomKeyStore operation on a custom key store
with a ConnectionState of DISCONNECTING or FAILED. This operation is valid
for all other ConnectionState values.

func (*CustomKeyStoreInvalidStateException) Code

func (s *CustomKeyStoreInvalidStateException) Code() string

Code returns the exception type name.

func (*CustomKeyStoreInvalidStateException) Error

func (s *CustomKeyStoreInvalidStateException) Error() string

func (CustomKeyStoreInvalidStateException) GoString

func (s CustomKeyStoreInvalidStateException) GoString() string

GoString returns the string representation

func (*CustomKeyStoreInvalidStateException) Message

func (s *CustomKeyStoreInvalidStateException) Message() string

Message returns the exception's message.

func (*CustomKeyStoreInvalidStateException) OrigErr

func (s *CustomKeyStoreInvalidStateException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*CustomKeyStoreInvalidStateException) RequestID

func (s *CustomKeyStoreInvalidStateException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*CustomKeyStoreInvalidStateException) StatusCode

func (s *CustomKeyStoreInvalidStateException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (CustomKeyStoreInvalidStateException) String

func (s CustomKeyStoreInvalidStateException) String() string

String returns the string representation

type CustomKeyStoreNameInUseException

type CustomKeyStoreNameInUseException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

The request was rejected because the specified custom key store name is already assigned to another custom key store in the account. Try again with a custom key store name that is unique in the account.

func (*CustomKeyStoreNameInUseException) Code

func (s *CustomKeyStoreNameInUseException) Code() string

Code returns the exception type name.

func (*CustomKeyStoreNameInUseException) Error

func (s *CustomKeyStoreNameInUseException) Error() string

func (CustomKeyStoreNameInUseException) GoString

func (s CustomKeyStoreNameInUseException) GoString() string

GoString returns the string representation

func (*CustomKeyStoreNameInUseException) Message

func (s *CustomKeyStoreNameInUseException) Message() string

Message returns the exception's message.

func (*CustomKeyStoreNameInUseException) OrigErr

func (s *CustomKeyStoreNameInUseException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*CustomKeyStoreNameInUseException) RequestID

func (s *CustomKeyStoreNameInUseException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*CustomKeyStoreNameInUseException) StatusCode

func (s *CustomKeyStoreNameInUseException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (CustomKeyStoreNameInUseException) String

func (s CustomKeyStoreNameInUseException) String() string

String returns the string representation

type CustomKeyStoreNotFoundException

type CustomKeyStoreNotFoundException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

The request was rejected because AWS KMS cannot find a custom key store with the specified key store name or ID.

func (*CustomKeyStoreNotFoundException) Code

func (s *CustomKeyStoreNotFoundException) Code() string

Code returns the exception type name.

func (*CustomKeyStoreNotFoundException) Error

func (s *CustomKeyStoreNotFoundException) Error() string

func (CustomKeyStoreNotFoundException) GoString

func (s CustomKeyStoreNotFoundException) GoString() string

GoString returns the string representation

func (*CustomKeyStoreNotFoundException) Message

func (s *CustomKeyStoreNotFoundException) Message() string

Message returns the exception's message.

func (*CustomKeyStoreNotFoundException) OrigErr

func (s *CustomKeyStoreNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*CustomKeyStoreNotFoundException) RequestID

func (s *CustomKeyStoreNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*CustomKeyStoreNotFoundException) StatusCode

func (s *CustomKeyStoreNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (CustomKeyStoreNotFoundException) String

func (s CustomKeyStoreNotFoundException) String() string

String returns the string representation

type CustomKeyStoresListEntry

type CustomKeyStoresListEntry struct {

    // A unique identifier for the AWS CloudHSM cluster that is associated with
    // the custom key store.
    CloudHsmClusterId *string `min:"19" type:"string"`

    // Describes the connection error. This field appears in the response only when
    // the ConnectionState is FAILED. For help resolving these errors, see How to
    // Fix a Connection Failure (https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-failed)
    // in AWS Key Management Service Developer Guide.
    //
    // Valid values are:
    //
    //    * CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with
    //    the specified cluster ID.
    //
    //    * INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does
    //    not contain any active HSMs. To connect a custom key store to its AWS
    //    CloudHSM cluster, the cluster must contain at least one active HSM.
    //
    //    * INTERNAL_ERROR - AWS KMS could not complete the request due to an internal
    //    error. Retry the request. For ConnectCustomKeyStore requests, disconnect
    //    the custom key store before trying to connect again.
    //
    //    * INVALID_CREDENTIALS - AWS KMS does not have the correct password for
    //    the kmsuser crypto user in the AWS CloudHSM cluster. Before you can connect
    //    your custom key store to its AWS CloudHSM cluster, you must change the
    //    kmsuser account password and update the key store password value for the
    //    custom key store.
    //
    //    * NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting
    //    to the custom key store.
    //
    //    * SUBNET_NOT_FOUND - A subnet in the AWS CloudHSM cluster configuration
    //    was deleted. If AWS KMS cannot find all of the subnets in the cluster
    //    configuration, attempts to connect the custom key store to the AWS CloudHSM
    //    cluster fail. To fix this error, create a cluster from a recent backup
    //    and associate it with your custom key store. (This process creates a new
    //    cluster configuration with a VPC and private subnets.) For details, see
    //    How to Fix a Connection Failure (https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-failed)
    //    in the AWS Key Management Service Developer Guide.
    //
    //    * USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated
    //    AWS CloudHSM cluster due to too many failed password attempts. Before
    //    you can connect your custom key store to its AWS CloudHSM cluster, you
    //    must change the kmsuser account password and update the key store password
    //    value for the custom key store.
    //
    //    * USER_LOGGED_IN - The kmsuser CU account is logged into the the associated
    //    AWS CloudHSM cluster. This prevents AWS KMS from rotating the kmsuser
    //    account password and logging into the cluster. Before you can connect
    //    your custom key store to its AWS CloudHSM cluster, you must log the kmsuser
    //    CU out of the cluster. If you changed the kmsuser password to log into
    //    the cluster, you must also and update the key store password value for
    //    the custom key store. For help, see How to Log Out and Reconnect (https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#login-kmsuser-2)
    //    in the AWS Key Management Service Developer Guide.
    //
    //    * USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated
    //    AWS CloudHSM cluster. Before you can connect your custom key store to
    //    its AWS CloudHSM cluster, you must create a kmsuser CU account in the
    //    cluster, and then update the key store password value for the custom key
    //    store.
    ConnectionErrorCode *string `type:"string" enum:"ConnectionErrorCodeType"`

    // Indicates whether the custom key store is connected to its AWS CloudHSM cluster.
    //
    // You can create and use CMKs in your custom key stores only when its connection
    // state is CONNECTED.
    //
    // The value is DISCONNECTED if the key store has never been connected or you
    // use the DisconnectCustomKeyStore operation to disconnect it. If the value
    // is CONNECTED but you are having trouble using the custom key store, make
    // sure that its associated AWS CloudHSM cluster is active and contains at least
    // one active HSM.
    //
    // A value of FAILED indicates that an attempt to connect was unsuccessful.
    // The ConnectionErrorCode field in the response indicates the cause of the
    // failure. For help resolving a connection failure, see Troubleshooting a Custom
    // Key Store (https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html)
    // in the AWS Key Management Service Developer Guide.
    ConnectionState *string `type:"string" enum:"ConnectionStateType"`

    // The date and time when the custom key store was created.
    CreationDate *time.Time `type:"timestamp"`

    // A unique identifier for the custom key store.
    CustomKeyStoreId *string `min:"1" type:"string"`

    // The user-specified friendly name for the custom key store.
    CustomKeyStoreName *string `min:"1" type:"string"`

    // The trust anchor certificate of the associated AWS CloudHSM cluster. When
    // you initialize the cluster (https://docs.aws.amazon.com/cloudhsm/latest/userguide/initialize-cluster.html#sign-csr),
    // you create this certificate and save it in the customerCA.crt file.
    TrustAnchorCertificate *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

Contains information about each custom key store in the custom key store list.

func (CustomKeyStoresListEntry) GoString

func (s CustomKeyStoresListEntry) GoString() string

GoString returns the string representation

func (*CustomKeyStoresListEntry) SetCloudHsmClusterId

func (s *CustomKeyStoresListEntry) SetCloudHsmClusterId(v string) *CustomKeyStoresListEntry

SetCloudHsmClusterId sets the CloudHsmClusterId field's value.

func (*CustomKeyStoresListEntry) SetConnectionErrorCode

func (s *CustomKeyStoresListEntry) SetConnectionErrorCode(v string) *CustomKeyStoresListEntry

SetConnectionErrorCode sets the ConnectionErrorCode field's value.

func (*CustomKeyStoresListEntry) SetConnectionState

func (s *CustomKeyStoresListEntry) SetConnectionState(v string) *CustomKeyStoresListEntry

SetConnectionState sets the ConnectionState field's value.

func (*CustomKeyStoresListEntry) SetCreationDate

func (s *CustomKeyStoresListEntry) SetCreationDate(v time.Time) *CustomKeyStoresListEntry

SetCreationDate sets the CreationDate field's value.

func (*CustomKeyStoresListEntry) SetCustomKeyStoreId

func (s *CustomKeyStoresListEntry) SetCustomKeyStoreId(v string) *CustomKeyStoresListEntry

SetCustomKeyStoreId sets the CustomKeyStoreId field's value.

func (*CustomKeyStoresListEntry) SetCustomKeyStoreName

func (s *CustomKeyStoresListEntry) SetCustomKeyStoreName(v string) *CustomKeyStoresListEntry

SetCustomKeyStoreName sets the CustomKeyStoreName field's value.

func (*CustomKeyStoresListEntry) SetTrustAnchorCertificate

func (s *CustomKeyStoresListEntry) SetTrustAnchorCertificate(v string) *CustomKeyStoresListEntry

SetTrustAnchorCertificate sets the TrustAnchorCertificate field's value.

func (CustomKeyStoresListEntry) String

func (s CustomKeyStoresListEntry) String() string

String returns the string representation

type DecryptInput

type DecryptInput struct {

    // Ciphertext to be decrypted. The blob includes metadata.
    //
    // CiphertextBlob is automatically base64 encoded/decoded by the SDK.
    //
    // CiphertextBlob is a required field
    CiphertextBlob []byte `min:"1" type:"blob" required:"true"`

    // Specifies the encryption algorithm that will be used to decrypt the ciphertext.
    // Specify the same algorithm that was used to encrypt the data. If you specify
    // a different algorithm, the Decrypt operation fails.
    //
    // This parameter is required only when the ciphertext was encrypted under an
    // asymmetric CMK. The default value, SYMMETRIC_DEFAULT, represents the only
    // supported algorithm that is valid for symmetric CMKs.
    EncryptionAlgorithm *string `type:"string" enum:"EncryptionAlgorithmSpec"`

    // Specifies the encryption context to use when decrypting the data. An encryption
    // context is valid only for cryptographic operations (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations)
    // with a symmetric CMK. The standard asymmetric encryption algorithms that
    // AWS KMS uses do not support an encryption context.
    //
    // An encryption context is a collection of non-secret key-value pairs that
    // represents additional authenticated data. When you use an encryption context
    // to encrypt data, you must specify the same (an exact case-sensitive match)
    // encryption context to decrypt the data. An encryption context is optional
    // when encrypting with a symmetric CMK, but it is highly recommended.
    //
    // For more information, see Encryption Context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context)
    // in the AWS Key Management Service Developer Guide.
    EncryptionContext map[string]*string `type:"map"`

    // A list of grant tokens.
    //
    // For more information, see Grant Tokens (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token)
    // in the AWS Key Management Service Developer Guide.
    GrantTokens []*string `type:"list"`

    // Specifies the customer master key (CMK) that AWS KMS will use to decrypt
    // the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext.
    //
    // If you specify a KeyId value, the Decrypt operation succeeds only if the
    // specified CMK was used to encrypt the ciphertext.
    //
    // This parameter is required only when the ciphertext was encrypted under an
    // asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the
    // ciphertext blob to determine which CMK was used to encrypt the ciphertext.
    // However, you can use this parameter to ensure that a particular CMK (of any
    // kind) is used to decrypt the ciphertext.
    //
    // To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name,
    // or alias ARN. When using an alias name, prefix it with "alias/".
    //
    // For example:
    //
    //    * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    //
    //    * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    //
    //    * Alias name: alias/ExampleAlias
    //
    //    * Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
    //
    // To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To
    // get the alias name and alias ARN, use ListAliases.
    KeyId *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (DecryptInput) GoString

func (s DecryptInput) GoString() string

GoString returns the string representation

func (*DecryptInput) SetCiphertextBlob

func (s *DecryptInput) SetCiphertextBlob(v []byte) *DecryptInput

SetCiphertextBlob sets the CiphertextBlob field's value.

func (*DecryptInput) SetEncryptionAlgorithm

func (s *DecryptInput) SetEncryptionAlgorithm(v string) *DecryptInput

SetEncryptionAlgorithm sets the EncryptionAlgorithm field's value.

func (*DecryptInput) SetEncryptionContext

func (s *DecryptInput) SetEncryptionContext(v map[string]*string) *DecryptInput

SetEncryptionContext sets the EncryptionContext field's value.

func (*DecryptInput) SetGrantTokens

func (s *DecryptInput) SetGrantTokens(v []*string) *DecryptInput

SetGrantTokens sets the GrantTokens field's value.

func (*DecryptInput) SetKeyId

func (s *DecryptInput) SetKeyId(v string) *DecryptInput

SetKeyId sets the KeyId field's value.

func (DecryptInput) String

func (s DecryptInput) String() string

String returns the string representation

func (*DecryptInput) Validate

func (s *DecryptInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DecryptOutput

type DecryptOutput struct {

    // The encryption algorithm that was used to decrypt the ciphertext.
    EncryptionAlgorithm *string `type:"string" enum:"EncryptionAlgorithmSpec"`

    // The Amazon Resource Name (key ARN (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN))
    // of the CMK that was used to decrypt the ciphertext.
    KeyId *string `min:"1" type:"string"`

    // Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value
    // is Base64-encoded. Otherwise, it is not Base64-encoded.
    //
    // Plaintext is automatically base64 encoded/decoded by the SDK.
    Plaintext []byte `min:"1" type:"blob" sensitive:"true"`
    // contains filtered or unexported fields
}

func (DecryptOutput) GoString

func (s DecryptOutput) GoString() string

GoString returns the string representation

func (*DecryptOutput) SetEncryptionAlgorithm

func (s *DecryptOutput) SetEncryptionAlgorithm(v string) *DecryptOutput

SetEncryptionAlgorithm sets the EncryptionAlgorithm field's value.

func (*DecryptOutput) SetKeyId

func (s *DecryptOutput) SetKeyId(v string) *DecryptOutput

SetKeyId sets the KeyId field's value.

func (*DecryptOutput) SetPlaintext

func (s *DecryptOutput) SetPlaintext(v []byte) *DecryptOutput

SetPlaintext sets the Plaintext field's value.

func (DecryptOutput) String

func (s DecryptOutput) String() string

String returns the string representation

type DeleteAliasInput

type DeleteAliasInput struct {

    // The alias to be deleted. The alias name must begin with alias/ followed by
    // the alias name, such as alias/ExampleAlias.
    //
    // AliasName is a required field
    AliasName *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteAliasInput) GoString

func (s DeleteAliasInput) GoString() string

GoString returns the string representation

func (*DeleteAliasInput) SetAliasName

func (s *DeleteAliasInput) SetAliasName(v string) *DeleteAliasInput

SetAliasName sets the AliasName field's value.

func (DeleteAliasInput) String

func (s DeleteAliasInput) String() string

String returns the string representation

func (*DeleteAliasInput) Validate

func (s *DeleteAliasInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteAliasOutput

type DeleteAliasOutput struct {
    // contains filtered or unexported fields
}

func (DeleteAliasOutput) GoString

func (s DeleteAliasOutput) GoString() string

GoString returns the string representation

func (DeleteAliasOutput) String

func (s DeleteAliasOutput) String() string

String returns the string representation

type DeleteCustomKeyStoreInput

type DeleteCustomKeyStoreInput struct {

    // Enter the ID of the custom key store you want to delete. To find the ID of
    // a custom key store, use the DescribeCustomKeyStores operation.
    //
    // CustomKeyStoreId is a required field
    CustomKeyStoreId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteCustomKeyStoreInput) GoString

func (s DeleteCustomKeyStoreInput) GoString() string

GoString returns the string representation

func (*DeleteCustomKeyStoreInput) SetCustomKeyStoreId

func (s *DeleteCustomKeyStoreInput) SetCustomKeyStoreId(v string) *DeleteCustomKeyStoreInput

SetCustomKeyStoreId sets the CustomKeyStoreId field's value.

func (DeleteCustomKeyStoreInput) String

func (s DeleteCustomKeyStoreInput) String() string

String returns the string representation

func (*DeleteCustomKeyStoreInput) Validate

func (s *DeleteCustomKeyStoreInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteCustomKeyStoreOutput

type DeleteCustomKeyStoreOutput struct {
    // contains filtered or unexported fields
}

func (DeleteCustomKeyStoreOutput) GoString

func (s DeleteCustomKeyStoreOutput) GoString() string

GoString returns the string representation

func (DeleteCustomKeyStoreOutput) String

func (s DeleteCustomKeyStoreOutput) String() string

String returns the string representation

type DeleteImportedKeyMaterialInput

type DeleteImportedKeyMaterialInput struct {

    // Identifies the CMK from which you are deleting imported key material. The
    // Origin of the CMK must be EXTERNAL.
    //
    // Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
    //
    // For example:
    //
    //    * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    //
    //    * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    //
    // To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
    //
    // KeyId is a required field
    KeyId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteImportedKeyMaterialInput) GoString

func (s DeleteImportedKeyMaterialInput) GoString() string

GoString returns the string representation

func (*DeleteImportedKeyMaterialInput) SetKeyId

func (s *DeleteImportedKeyMaterialInput) SetKeyId(v string) *DeleteImportedKeyMaterialInput

SetKeyId sets the KeyId field's value.

func (DeleteImportedKeyMaterialInput) String

func (s DeleteImportedKeyMaterialInput) String() string

String returns the string representation

func (*DeleteImportedKeyMaterialInput) Validate

func (s *DeleteImportedKeyMaterialInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteImportedKeyMaterialOutput

type DeleteImportedKeyMaterialOutput struct {
    // contains filtered or unexported fields
}

func (DeleteImportedKeyMaterialOutput) GoString

func (s DeleteImportedKeyMaterialOutput) GoString() string

GoString returns the string representation

func (DeleteImportedKeyMaterialOutput) String

func (s DeleteImportedKeyMaterialOutput) String() string

String returns the string representation

type DependencyTimeoutException

type DependencyTimeoutException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

The system timed out while trying to fulfill the request. The request can be retried.

func (*DependencyTimeoutException) Code

func (s *DependencyTimeoutException) Code() string

Code returns the exception type name.

func (*DependencyTimeoutException) Error

func (s *DependencyTimeoutException) Error() string

func (DependencyTimeoutException) GoString

func (s DependencyTimeoutException) GoString() string

GoString returns the string representation

func (*DependencyTimeoutException) Message

func (s *DependencyTimeoutException) Message() string

Message returns the exception's message.

func (*DependencyTimeoutException) OrigErr

func (s *DependencyTimeoutException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*DependencyTimeoutException) RequestID

func (s *DependencyTimeoutException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*DependencyTimeoutException) StatusCode

func (s *DependencyTimeoutException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (DependencyTimeoutException) String

func (s DependencyTimeoutException) String() string

String returns the string representation

type DescribeCustomKeyStoresInput

type DescribeCustomKeyStoresInput struct {

    // Gets only information about the specified custom key store. Enter the key
    // store ID.
    //
    // By default, this operation gets information about all custom key stores in
    // the account and region. To limit the output to a particular custom key store,
    // you can use either the CustomKeyStoreId or CustomKeyStoreName parameter,
    // but not both.
    CustomKeyStoreId *string `min:"1" type:"string"`

    // Gets only information about the specified custom key store. Enter the friendly
    // name of the custom key store.
    //
    // By default, this operation gets information about all custom key stores in
    // the account and region. To limit the output to a particular custom key store,
    // you can use either the CustomKeyStoreId or CustomKeyStoreName parameter,
    // but not both.
    CustomKeyStoreName *string `min:"1" type:"string"`

    // Use this parameter to specify the maximum number of items to return. When
    // this value is present, AWS KMS does not return more than the specified number
    // of items, but it might return fewer.
    Limit *int64 `min:"1" type:"integer"`

    // Use this parameter in a subsequent request after you receive a response with
    // truncated results. Set it to the value of NextMarker from the truncated response
    // you just received.
    Marker *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (DescribeCustomKeyStoresInput) GoString

func (s DescribeCustomKeyStoresInput) GoString() string

GoString returns the string representation

func (*DescribeCustomKeyStoresInput) SetCustomKeyStoreId

func (s *DescribeCustomKeyStoresInput) SetCustomKeyStoreId(v string) *DescribeCustomKeyStoresInput

SetCustomKeyStoreId sets the CustomKeyStoreId field's value.

func (*DescribeCustomKeyStoresInput) SetCustomKeyStoreName

func (s *DescribeCustomKeyStoresInput) SetCustomKeyStoreName(v string) *DescribeCustomKeyStoresInput

SetCustomKeyStoreName sets the CustomKeyStoreName field's value.

func (*DescribeCustomKeyStoresInput) SetLimit

func (s *DescribeCustomKeyStoresInput) SetLimit(v int64) *DescribeCustomKeyStoresInput

SetLimit sets the Limit field's value.

func (*DescribeCustomKeyStoresInput) SetMarker

func (s *DescribeCustomKeyStoresInput) SetMarker(v string) *DescribeCustomKeyStoresInput

SetMarker sets the Marker field's value.

func (DescribeCustomKeyStoresInput) String

func (s DescribeCustomKeyStoresInput) String() string

String returns the string representation

func (*DescribeCustomKeyStoresInput) Validate

func (s *DescribeCustomKeyStoresInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeCustomKeyStoresOutput

type DescribeCustomKeyStoresOutput struct {

    // Contains metadata about each custom key store.
    CustomKeyStores []*CustomKeyStoresListEntry `type:"list"`

    // When Truncated is true, this element is present and contains the value to
    // use for the Marker parameter in a subsequent request.
    NextMarker *string `min:"1" type:"string"`

    // A flag that indicates whether there are more items in the list. When this
    // value is true, the list in this response is truncated. To get more items,
    // pass the value of the NextMarker element in thisresponse to the Marker parameter
    // in a subsequent request.
    Truncated *bool `type:"boolean"`
    // contains filtered or unexported fields
}

func (DescribeCustomKeyStoresOutput) GoString

func (s DescribeCustomKeyStoresOutput) GoString() string

GoString returns the string representation

func (*DescribeCustomKeyStoresOutput) SetCustomKeyStores

func (s *DescribeCustomKeyStoresOutput) SetCustomKeyStores(v []*CustomKeyStoresListEntry) *DescribeCustomKeyStoresOutput

SetCustomKeyStores sets the CustomKeyStores field's value.

func (*DescribeCustomKeyStoresOutput) SetNextMarker

func (s *DescribeCustomKeyStoresOutput) SetNextMarker(v string) *DescribeCustomKeyStoresOutput

SetNextMarker sets the NextMarker field's value.

func (*DescribeCustomKeyStoresOutput) SetTruncated

func (s *DescribeCustomKeyStoresOutput) SetTruncated(v bool) *DescribeCustomKeyStoresOutput

SetTruncated sets the Truncated field's value.

func (DescribeCustomKeyStoresOutput) String

func (s DescribeCustomKeyStoresOutput) String() string

String returns the string representation

type DescribeKeyInput

type DescribeKeyInput struct {

    // A list of grant tokens.
    //
    // For more information, see Grant Tokens (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token)
    // in the AWS Key Management Service Developer Guide.
    GrantTokens []*string `type:"list"`

    // Describes the specified customer master key (CMK).
    //
    // If you specify a predefined AWS alias (an AWS alias with no key ID), KMS
    // associates the alias with an AWS managed CMK (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys)
    // and returns its KeyId and Arn in the response.
    //
    // To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name,
    // or alias ARN. When using an alias name, prefix it with "alias/". To specify
    // a CMK in a different AWS account, you must use the key ARN or alias ARN.
    //
    // For example:
    //
    //    * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    //
    //    * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    //
    //    * Alias name: alias/ExampleAlias
    //
    //    * Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
    //
    // To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To
    // get the alias name and alias ARN, use ListAliases.
    //
    // KeyId is a required field
    KeyId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeKeyInput) GoString

func (s DescribeKeyInput) GoString() string

GoString returns the string representation

func (*DescribeKeyInput) SetGrantTokens

func (s *DescribeKeyInput) SetGrantTokens(v []*string) *DescribeKeyInput

SetGrantTokens sets the GrantTokens field's value.

func (*DescribeKeyInput) SetKeyId

func (s *DescribeKeyInput) SetKeyId(v string) *DescribeKeyInput

SetKeyId sets the KeyId field's value.

func (DescribeKeyInput) String

func (s DescribeKeyInput) String() string

String returns the string representation

func (*DescribeKeyInput) Validate

func (s *DescribeKeyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeKeyOutput

type DescribeKeyOutput struct {

    // Metadata associated with the key.
    KeyMetadata *KeyMetadata `type:"structure"`
    // contains filtered or unexported fields
}

func (DescribeKeyOutput) GoString

func (s DescribeKeyOutput) GoString() string

GoString returns the string representation

func (*DescribeKeyOutput) SetKeyMetadata

func (s *DescribeKeyOutput) SetKeyMetadata(v *KeyMetadata) *DescribeKeyOutput

SetKeyMetadata sets the KeyMetadata field's value.

func (DescribeKeyOutput) String

func (s DescribeKeyOutput) String() string

String returns the string representation

type DisableKeyInput

type DisableKeyInput struct {

    // A unique identifier for the customer master key (CMK).
    //
    // Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
    //
    // For example:
    //
    //    * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    //
    //    * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    //
    // To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
    //
    // KeyId is a required field
    KeyId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DisableKeyInput) GoString

func (s DisableKeyInput) GoString() string

GoString returns the string representation

func (*DisableKeyInput) SetKeyId

func (s *DisableKeyInput) SetKeyId(v string) *DisableKeyInput

SetKeyId sets the KeyId field's value.

func (DisableKeyInput) String

func (s DisableKeyInput) String() string

String returns the string representation

func (*DisableKeyInput) Validate

func (s *DisableKeyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DisableKeyOutput

type DisableKeyOutput struct {
    // contains filtered or unexported fields
}

func (DisableKeyOutput) GoString

func (s DisableKeyOutput) GoString() string

GoString returns the string representation

func (DisableKeyOutput) String

func (s DisableKeyOutput) String() string

String returns the string representation

type DisableKeyRotationInput

type DisableKeyRotationInput struct {

    // Identifies a symmetric customer master key (CMK). You cannot enable automatic
    // rotation of asymmetric CMKs (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html#asymmetric-cmks),
    // CMKs with imported key material (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html),
    // or CMKs in a custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html).
    //
    // Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
    //
    // For example:
    //
    //    * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    //
    //    * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    //
    // To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
    //
    // KeyId is a required field
    KeyId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DisableKeyRotationInput) GoString

func (s DisableKeyRotationInput) GoString() string

GoString returns the string representation

func (*DisableKeyRotationInput) SetKeyId

func (s *DisableKeyRotationInput) SetKeyId(v string) *DisableKeyRotationInput

SetKeyId sets the KeyId field's value.

func (DisableKeyRotationInput) String

func (s DisableKeyRotationInput) String() string

String returns the string representation

func (*DisableKeyRotationInput) Validate

func (s *DisableKeyRotationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DisableKeyRotationOutput

type DisableKeyRotationOutput struct {
    // contains filtered or unexported fields
}

func (DisableKeyRotationOutput) GoString

func (s DisableKeyRotationOutput) GoString() string

GoString returns the string representation

func (DisableKeyRotationOutput) String

func (s DisableKeyRotationOutput) String() string

String returns the string representation

type DisabledException

type DisabledException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

The request was rejected because the specified CMK is not enabled.

func (*DisabledException) Code

func (s *DisabledException) Code() string

Code returns the exception type name.

func (*DisabledException) Error

func (s *DisabledException) Error() string

func (DisabledException) GoString

func (s DisabledException) GoString() string

GoString returns the string representation

func (*DisabledException) Message

func (s *DisabledException) Message() string

Message returns the exception's message.

func (*DisabledException) OrigErr

func (s *DisabledException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*DisabledException) RequestID

func (s *DisabledException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*DisabledException) StatusCode

func (s *DisabledException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (DisabledException) String

func (s DisabledException) String() string

String returns the string representation

type DisconnectCustomKeyStoreInput

type DisconnectCustomKeyStoreInput struct {

    // Enter the ID of the custom key store you want to disconnect. To find the
    // ID of a custom key store, use the DescribeCustomKeyStores operation.
    //
    // CustomKeyStoreId is a required field
    CustomKeyStoreId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DisconnectCustomKeyStoreInput) GoString

func (s DisconnectCustomKeyStoreInput) GoString() string

GoString returns the string representation

func (*DisconnectCustomKeyStoreInput) SetCustomKeyStoreId

func (s *DisconnectCustomKeyStoreInput) SetCustomKeyStoreId(v string) *DisconnectCustomKeyStoreInput

SetCustomKeyStoreId sets the CustomKeyStoreId field's value.

func (DisconnectCustomKeyStoreInput) String

func (s DisconnectCustomKeyStoreInput) String() string

String returns the string representation

func (*DisconnectCustomKeyStoreInput) Validate

func (s *DisconnectCustomKeyStoreInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DisconnectCustomKeyStoreOutput

type DisconnectCustomKeyStoreOutput struct {
    // contains filtered or unexported fields
}

func (DisconnectCustomKeyStoreOutput) GoString

func (s DisconnectCustomKeyStoreOutput) GoString() string

GoString returns the string representation

func (DisconnectCustomKeyStoreOutput) String

func (s DisconnectCustomKeyStoreOutput) String() string

String returns the string representation

type EnableKeyInput

type EnableKeyInput struct {

    // A unique identifier for the customer master key (CMK).
    //
    // Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
    //
    // For example:
    //
    //    * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    //
    //    * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    //
    // To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
    //
    // KeyId is a required field
    KeyId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (EnableKeyInput) GoString

func (s EnableKeyInput) GoString() string

GoString returns the string representation

func (*EnableKeyInput) SetKeyId

func (s *EnableKeyInput) SetKeyId(v string) *EnableKeyInput

SetKeyId sets the KeyId field's value.

func (EnableKeyInput) String

func (s EnableKeyInput) String() string

String returns the string representation

func (*EnableKeyInput) Validate

func (s *EnableKeyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EnableKeyOutput

type EnableKeyOutput struct {
    // contains filtered or unexported fields
}

func (EnableKeyOutput) GoString

func (s EnableKeyOutput) GoString() string

GoString returns the string representation

func (EnableKeyOutput) String

func (s EnableKeyOutput) String() string

String returns the string representation

type EnableKeyRotationInput

type EnableKeyRotationInput struct {

    // Identifies a symmetric customer master key (CMK). You cannot enable automatic
    // rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in
    // a custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html).
    //
    // Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
    //
    // For example:
    //
    //    * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    //
    //    * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    //
    // To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
    //
    // KeyId is a required field
    KeyId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (EnableKeyRotationInput) GoString

func (s EnableKeyRotationInput) GoString() string

GoString returns the string representation

func (*EnableKeyRotationInput) SetKeyId

func (s *EnableKeyRotationInput) SetKeyId(v string) *EnableKeyRotationInput

SetKeyId sets the KeyId field's value.

func (EnableKeyRotationInput) String

func (s EnableKeyRotationInput) String() string

String returns the string representation

func (*EnableKeyRotationInput) Validate

func (s *EnableKeyRotationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EnableKeyRotationOutput

type EnableKeyRotationOutput struct {
    // contains filtered or unexported fields
}

func (EnableKeyRotationOutput) GoString

func (s EnableKeyRotationOutput) GoString() string

GoString returns the string representation

func (EnableKeyRotationOutput) String

func (s EnableKeyRotationOutput) String() string

String returns the string representation

type EncryptInput

type EncryptInput struct {

    // Specifies the encryption algorithm that AWS KMS will use to encrypt the plaintext
    // message. The algorithm must be compatible with the CMK that you specify.
    //
    // This parameter is required only for asymmetric CMKs. The default value, SYMMETRIC_DEFAULT,
    // is the algorithm used for symmetric CMKs. If you are using an asymmetric
    // CMK, we recommend RSAES_OAEP_SHA_256.
    EncryptionAlgorithm *string `type:"string" enum:"EncryptionAlgorithmSpec"`

    // Specifies the encryption context that will be used to encrypt the data. An
    // encryption context is valid only for cryptographic operations (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations)
    // with a symmetric CMK. The standard asymmetric encryption algorithms that
    // AWS KMS uses do not support an encryption context.
    //
    // An encryption context is a collection of non-secret key-value pairs that
    // represents additional authenticated data. When you use an encryption context
    // to encrypt data, you must specify the same (an exact case-sensitive match)
    // encryption context to decrypt the data. An encryption context is optional
    // when encrypting with a symmetric CMK, but it is highly recommended.
    //
    // For more information, see Encryption Context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context)
    // in the AWS Key Management Service Developer Guide.
    EncryptionContext map[string]*string `type:"map"`

    // A list of grant tokens.
    //
    // For more information, see Grant Tokens (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token)
    // in the AWS Key Management Service Developer Guide.
    GrantTokens []*string `type:"list"`

    // A unique identifier for the customer master key (CMK).
    //
    // To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name,
    // or alias ARN. When using an alias name, prefix it with "alias/". To specify
    // a CMK in a different AWS account, you must use the key ARN or alias ARN.
    //
    // For example:
    //
    //    * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    //
    //    * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    //
    //    * Alias name: alias/ExampleAlias
    //
    //    * Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
    //
    // To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To
    // get the alias name and alias ARN, use ListAliases.
    //
    // KeyId is a required field
    KeyId *string `min:"1" type:"string" required:"true"`

    // Data to be encrypted.
    //
    // Plaintext is automatically base64 encoded/decoded by the SDK.
    //
    // Plaintext is a required field
    Plaintext []byte `min:"1" type:"blob" required:"true" sensitive:"true"`
    // contains filtered or unexported fields
}

func (EncryptInput) GoString

func (s EncryptInput) GoString() string

GoString returns the string representation

func (*EncryptInput) SetEncryptionAlgorithm

func (s *EncryptInput) SetEncryptionAlgorithm(v string) *EncryptInput

SetEncryptionAlgorithm sets the EncryptionAlgorithm field's value.

func (*EncryptInput) SetEncryptionContext

func (s *EncryptInput) SetEncryptionContext(v map[string]*string) *EncryptInput

SetEncryptionContext sets the EncryptionContext field's value.

func (*EncryptInput) SetGrantTokens

func (s *EncryptInput) SetGrantTokens(v []*string) *EncryptInput

SetGrantTokens sets the GrantTokens field's value.

func (*EncryptInput) SetKeyId

func (s *EncryptInput) SetKeyId(v string) *EncryptInput

SetKeyId sets the KeyId field's value.

func (*EncryptInput) SetPlaintext

func (s *EncryptInput) SetPlaintext(v []byte) *EncryptInput

SetPlaintext sets the Plaintext field's value.

func (EncryptInput) String

func (s EncryptInput) String() string

String returns the string representation

func (*EncryptInput) Validate

func (s *EncryptInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EncryptOutput

type EncryptOutput struct {

    // The encrypted plaintext. When you use the HTTP API or the AWS CLI, the value
    // is Base64-encoded. Otherwise, it is not Base64-encoded.
    //
    // CiphertextBlob is automatically base64 encoded/decoded by the SDK.
    CiphertextBlob []byte `min:"1" type:"blob"`

    // The encryption algorithm that was used to encrypt the plaintext.
    EncryptionAlgorithm *string `type:"string" enum:"EncryptionAlgorithmSpec"`

    // The Amazon Resource Name (key ARN (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN))
    // of the CMK that was used to encrypt the plaintext.
    KeyId *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (EncryptOutput) GoString

func (s EncryptOutput) GoString() string

GoString returns the string representation

func (*EncryptOutput) SetCiphertextBlob

func (s *EncryptOutput) SetCiphertextBlob(v []byte) *EncryptOutput

SetCiphertextBlob sets the CiphertextBlob field's value.

func (*EncryptOutput) SetEncryptionAlgorithm

func (s *EncryptOutput) SetEncryptionAlgorithm(v string) *EncryptOutput

SetEncryptionAlgorithm sets the EncryptionAlgorithm field's value.

func (*EncryptOutput) SetKeyId

func (s *EncryptOutput) SetKeyId(v string) *EncryptOutput

SetKeyId sets the KeyId field's value.

func (EncryptOutput) String

func (s EncryptOutput) String() string

String returns the string representation

type ExpiredImportTokenException

type ExpiredImportTokenException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

The request was rejected because the specified import token is expired. Use GetParametersForImport to get a new import token and public key, use the new public key to encrypt the key material, and then try the request again.

func (*ExpiredImportTokenException) Code

func (s *ExpiredImportTokenException) Code() string

Code returns the exception type name.

func (*ExpiredImportTokenException) Error

func (s *ExpiredImportTokenException) Error() string

func (ExpiredImportTokenException) GoString

func (s ExpiredImportTokenException) GoString() string

GoString returns the string representation

func (*ExpiredImportTokenException) Message

func (s *ExpiredImportTokenException) Message() string

Message returns the exception's message.

func (*ExpiredImportTokenException) OrigErr

func (s *ExpiredImportTokenException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ExpiredImportTokenException) RequestID

func (s *ExpiredImportTokenException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ExpiredImportTokenException) StatusCode

func (s *ExpiredImportTokenException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ExpiredImportTokenException) String

func (s ExpiredImportTokenException) String() string

String returns the string representation

type GenerateDataKeyInput

type GenerateDataKeyInput struct {

    // Specifies the encryption context that will be used when encrypting the data
    // key.
    //
    // An encryption context is a collection of non-secret key-value pairs that
    // represents additional authenticated data. When you use an encryption context
    // to encrypt data, you must specify the same (an exact case-sensitive match)
    // encryption context to decrypt the data. An encryption context is optional
    // when encrypting with a symmetric CMK, but it is highly recommended.
    //
    // For more information, see Encryption Context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context)
    // in the AWS Key Management Service Developer Guide.
    EncryptionContext map[string]*string `type:"map"`

    // A list of grant tokens.
    //
    // For more information, see Grant Tokens (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token)
    // in the AWS Key Management Service Developer Guide.
    GrantTokens []*string `type:"list"`

    // Identifies the symmetric CMK that encrypts the data key.
    //
    // To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name,
    // or alias ARN. When using an alias name, prefix it with "alias/". To specify
    // a CMK in a different AWS account, you must use the key ARN or alias ARN.
    //
    // For example:
    //
    //    * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    //
    //    * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    //
    //    * Alias name: alias/ExampleAlias
    //
    //    * Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
    //
    // To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To
    // get the alias name and alias ARN, use ListAliases.
    //
    // KeyId is a required field
    KeyId *string `min:"1" type:"string" required:"true"`

    // Specifies the length of the data key. Use AES_128 to generate a 128-bit symmetric
    // key, or AES_256 to generate a 256-bit symmetric key.
    //
    // You must specify either the KeySpec or the NumberOfBytes parameter (but not
    // both) in every GenerateDataKey request.
    KeySpec *string `type:"string" enum:"DataKeySpec"`

    // Specifies the length of the data key in bytes. For example, use the value
    // 64 to generate a 512-bit data key (64 bytes is 512 bits). For 128-bit (16-byte)
    // and 256-bit (32-byte) data keys, use the KeySpec parameter.
    //
    // You must specify either the KeySpec or the NumberOfBytes parameter (but not
    // both) in every GenerateDataKey request.
    NumberOfBytes *int64 `min:"1" type:"integer"`
    // contains filtered or unexported fields
}

func (GenerateDataKeyInput) GoString

func (s GenerateDataKeyInput) GoString() string

GoString returns the string representation

func (*GenerateDataKeyInput) SetEncryptionContext

func (s *GenerateDataKeyInput) SetEncryptionContext(v map[string]*string) *GenerateDataKeyInput

SetEncryptionContext sets the EncryptionContext field's value.

func (*GenerateDataKeyInput) SetGrantTokens

func (s *GenerateDataKeyInput) SetGrantTokens(v []*string) *GenerateDataKeyInput

SetGrantTokens sets the GrantTokens field's value.

func (*GenerateDataKeyInput) SetKeyId

func (s *GenerateDataKeyInput) SetKeyId(v string) *GenerateDataKeyInput

SetKeyId sets the KeyId field's value.

func (*GenerateDataKeyInput) SetKeySpec

func (s *GenerateDataKeyInput) SetKeySpec(v string) *GenerateDataKeyInput

SetKeySpec sets the KeySpec field's value.

func (*GenerateDataKeyInput) SetNumberOfBytes

func (s *GenerateDataKeyInput) SetNumberOfBytes(v int64) *GenerateDataKeyInput

SetNumberOfBytes sets the NumberOfBytes field's value.

func (GenerateDataKeyInput) String

func (s GenerateDataKeyInput) String() string

String returns the string representation

func (*GenerateDataKeyInput) Validate

func (s *GenerateDataKeyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GenerateDataKeyOutput

type GenerateDataKeyOutput struct {

    // The encrypted copy of the data key. When you use the HTTP API or the AWS
    // CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
    //
    // CiphertextBlob is automatically base64 encoded/decoded by the SDK.
    CiphertextBlob []byte `min:"1" type:"blob"`

    // The Amazon Resource Name (key ARN (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN))
    // of the CMK that encrypted the data key.
    KeyId *string `min:"1" type:"string"`

    // The plaintext data key. When you use the HTTP API or the AWS CLI, the value
    // is Base64-encoded. Otherwise, it is not Base64-encoded. Use this data key
    // to encrypt your data outside of KMS. Then, remove it from memory as soon
    // as possible.
    //
    // Plaintext is automatically base64 encoded/decoded by the SDK.
    Plaintext []byte `min:"1" type:"blob" sensitive:"true"`
    // contains filtered or unexported fields
}

func (GenerateDataKeyOutput) GoString

func (s GenerateDataKeyOutput) GoString() string

GoString returns the string representation

func (*GenerateDataKeyOutput) SetCiphertextBlob

func (s *GenerateDataKeyOutput) SetCiphertextBlob(v []byte) *GenerateDataKeyOutput

SetCiphertextBlob sets the CiphertextBlob field's value.

func (*GenerateDataKeyOutput) SetKeyId

func (s *GenerateDataKeyOutput) SetKeyId(v string) *GenerateDataKeyOutput

SetKeyId sets the KeyId field's value.

func (*GenerateDataKeyOutput) SetPlaintext

func (s *GenerateDataKeyOutput) SetPlaintext(v []byte) *GenerateDataKeyOutput

SetPlaintext sets the Plaintext field's value.

func (GenerateDataKeyOutput) String

func (s GenerateDataKeyOutput) String() string

String returns the string representation

type GenerateDataKeyPairInput

type GenerateDataKeyPairInput struct {

    // Specifies the encryption context that will be used when encrypting the private
    // key in the data key pair.
    //
    // An encryption context is a collection of non-secret key-value pairs that
    // represents additional authenticated data. When you use an encryption context
    // to encrypt data, you must specify the same (an exact case-sensitive match)
    // encryption context to decrypt the data. An encryption context is optional
    // when encrypting with a symmetric CMK, but it is highly recommended.
    //
    // For more information, see Encryption Context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context)
    // in the AWS Key Management Service Developer Guide.
    EncryptionContext map[string]*string `type:"map"`

    // A list of grant tokens.
    //
    // For more information, see Grant Tokens (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token)
    // in the AWS Key Management Service Developer Guide.
    GrantTokens []*string `type:"list"`

    // Specifies the symmetric CMK that encrypts the private key in the data key
    // pair. You cannot specify an asymmetric CMK or a CMK in a custom key store.
    // To get the type and origin of your CMK, use the DescribeKey operation.
    //
    // To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name,
    // or alias ARN. When using an alias name, prefix it with "alias/". To specify
    // a CMK in a different AWS account, you must use the key ARN or alias ARN.
    //
    // For example:
    //
    //    * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    //
    //    * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    //
    //    * Alias name: alias/ExampleAlias
    //
    //    * Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
    //
    // To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To
    // get the alias name and alias ARN, use ListAliases.
    //
    // KeyId is a required field
    KeyId *string `min:"1" type:"string" required:"true"`

    // Determines the type of data key pair that is generated.
    //
    // The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt
    // and decrypt or to sign and verify (but not both), and the rule that permits
    // you to use ECC CMKs only to sign and verify, are not effective outside of
    // AWS KMS.
    //
    // KeyPairSpec is a required field
    KeyPairSpec *string `type:"string" required:"true" enum:"DataKeyPairSpec"`
    // contains filtered or unexported fields
}

func (GenerateDataKeyPairInput) GoString

func (s GenerateDataKeyPairInput) GoString() string

GoString returns the string representation

func (*GenerateDataKeyPairInput) SetEncryptionContext

func (s *GenerateDataKeyPairInput) SetEncryptionContext(v map[string]*string) *GenerateDataKeyPairInput

SetEncryptionContext sets the EncryptionContext field's value.

func (*GenerateDataKeyPairInput) SetGrantTokens

func (s *GenerateDataKeyPairInput) SetGrantTokens(v []*string) *GenerateDataKeyPairInput

SetGrantTokens sets the GrantTokens field's value.

func (*GenerateDataKeyPairInput) SetKeyId

func (s *GenerateDataKeyPairInput) SetKeyId(v string) *GenerateDataKeyPairInput

SetKeyId sets the KeyId field's value.

func (*GenerateDataKeyPairInput) SetKeyPairSpec

func (s *GenerateDataKeyPairInput) SetKeyPairSpec(v string) *GenerateDataKeyPairInput

SetKeyPairSpec sets the KeyPairSpec field's value.

func (GenerateDataKeyPairInput) String

func (s GenerateDataKeyPairInput) String() string

String returns the string representation

func (*GenerateDataKeyPairInput) Validate

func (s *GenerateDataKeyPairInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GenerateDataKeyPairOutput

type GenerateDataKeyPairOutput struct {

    // The Amazon Resource Name (key ARN (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN))
    // of the CMK that encrypted the private key.
    KeyId *string `min:"1" type:"string"`

    // The type of data key pair that was generated.
    KeyPairSpec *string `type:"string" enum:"DataKeyPairSpec"`

    // The encrypted copy of the private key. When you use the HTTP API or the AWS
    // CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
    //
    // PrivateKeyCiphertextBlob is automatically base64 encoded/decoded by the SDK.
    PrivateKeyCiphertextBlob []byte `min:"1" type:"blob"`

    // The plaintext copy of the private key. When you use the HTTP API or the AWS
    // CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
    //
    // PrivateKeyPlaintext is automatically base64 encoded/decoded by the SDK.
    PrivateKeyPlaintext []byte `min:"1" type:"blob" sensitive:"true"`

    // The public key (in plaintext).
    //
    // PublicKey is automatically base64 encoded/decoded by the SDK.
    PublicKey []byte `min:"1" type:"blob"`
    // contains filtered or unexported fields
}

func (GenerateDataKeyPairOutput) GoString

func (s GenerateDataKeyPairOutput) GoString() string

GoString returns the string representation

func (*GenerateDataKeyPairOutput) SetKeyId

func (s *GenerateDataKeyPairOutput) SetKeyId(v string) *GenerateDataKeyPairOutput

SetKeyId sets the KeyId field's value.

func (*GenerateDataKeyPairOutput) SetKeyPairSpec

func (s *GenerateDataKeyPairOutput) SetKeyPairSpec(v string) *GenerateDataKeyPairOutput

SetKeyPairSpec sets the KeyPairSpec field's value.

func (*GenerateDataKeyPairOutput) SetPrivateKeyCiphertextBlob

func (s *GenerateDataKeyPairOutput) SetPrivateKeyCiphertextBlob(v []byte) *GenerateDataKeyPairOutput

SetPrivateKeyCiphertextBlob sets the PrivateKeyCiphertextBlob field's value.

func (*GenerateDataKeyPairOutput) SetPrivateKeyPlaintext

func (s *GenerateDataKeyPairOutput) SetPrivateKeyPlaintext(v []byte) *GenerateDataKeyPairOutput

SetPrivateKeyPlaintext sets the PrivateKeyPlaintext field's value.

func (*GenerateDataKeyPairOutput) SetPublicKey

func (s *GenerateDataKeyPairOutput) SetPublicKey(v []byte) *GenerateDataKeyPairOutput

SetPublicKey sets the PublicKey field's value.

func (GenerateDataKeyPairOutput) String

func (s GenerateDataKeyPairOutput) String() string

String returns the string representation

type GenerateDataKeyPairWithoutPlaintextInput

type GenerateDataKeyPairWithoutPlaintextInput struct {

    // Specifies the encryption context that will be used when encrypting the private
    // key in the data key pair.
    //
    // An encryption context is a collection of non-secret key-value pairs that
    // represents additional authenticated data. When you use an encryption context
    // to encrypt data, you must specify the same (an exact case-sensitive match)
    // encryption context to decrypt the data. An encryption context is optional
    // when encrypting with a symmetric CMK, but it is highly recommended.
    //
    // For more information, see Encryption Context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context)
    // in the AWS Key Management Service Developer Guide.
    EncryptionContext map[string]*string `type:"map"`

    // A list of grant tokens.
    //
    // For more information, see Grant Tokens (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token)
    // in the AWS Key Management Service Developer Guide.
    GrantTokens []*string `type:"list"`

    // Specifies the CMK that encrypts the private key in the data key pair. You
    // must specify a symmetric CMK. You cannot use an asymmetric CMK or a CMK in
    // a custom key store. To get the type and origin of your CMK, use the DescribeKey
    // operation.
    //
    // To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name,
    // or alias ARN. When using an alias name, prefix it with "alias/".
    //
    // For example:
    //
    //    * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    //
    //    * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    //
    //    * Alias name: alias/ExampleAlias
    //
    //    * Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
    //
    // To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To
    // get the alias name and alias ARN, use ListAliases.
    //
    // KeyId is a required field
    KeyId *string `min:"1" type:"string" required:"true"`

    // Determines the type of data key pair that is generated.
    //
    // The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt
    // and decrypt or to sign and verify (but not both), and the rule that permits
    // you to use ECC CMKs only to sign and verify, are not effective outside of
    // AWS KMS.
    //
    // KeyPairSpec is a required field
    KeyPairSpec *string `type:"string" required:"true" enum:"DataKeyPairSpec"`
    // contains filtered or unexported fields
}

func (GenerateDataKeyPairWithoutPlaintextInput) GoString

func (s GenerateDataKeyPairWithoutPlaintextInput) GoString() string

GoString returns the string representation

func (*GenerateDataKeyPairWithoutPlaintextInput) SetEncryptionContext

func (s *GenerateDataKeyPairWithoutPlaintextInput) SetEncryptionContext(v map[string]*string) *GenerateDataKeyPairWithoutPlaintextInput

SetEncryptionContext sets the EncryptionContext field's value.

func (*GenerateDataKeyPairWithoutPlaintextInput) SetGrantTokens

func (s *GenerateDataKeyPairWithoutPlaintextInput) SetGrantTokens(v []*string) *GenerateDataKeyPairWithoutPlaintextInput

SetGrantTokens sets the GrantTokens field's value.

func (*GenerateDataKeyPairWithoutPlaintextInput) SetKeyId

func (s *GenerateDataKeyPairWithoutPlaintextInput) SetKeyId(v string) *GenerateDataKeyPairWithoutPlaintextInput

SetKeyId sets the KeyId field's value.

func (*GenerateDataKeyPairWithoutPlaintextInput) SetKeyPairSpec

func (s *GenerateDataKeyPairWithoutPlaintextInput) SetKeyPairSpec(v string) *GenerateDataKeyPairWithoutPlaintextInput

SetKeyPairSpec sets the KeyPairSpec field's value.

func (GenerateDataKeyPairWithoutPlaintextInput) String

func (s GenerateDataKeyPairWithoutPlaintextInput) String() string

String returns the string representation

func (*GenerateDataKeyPairWithoutPlaintextInput) Validate

func (s *GenerateDataKeyPairWithoutPlaintextInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GenerateDataKeyPairWithoutPlaintextOutput

type GenerateDataKeyPairWithoutPlaintextOutput struct {

    // The Amazon Resource Name (key ARN (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN))
    // of the CMK that encrypted the private key.
    KeyId *string `min:"1" type:"string"`

    // The type of data key pair that was generated.
    KeyPairSpec *string `type:"string" enum:"DataKeyPairSpec"`

    // The encrypted copy of the private key. When you use the HTTP API or the AWS
    // CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
    //
    // PrivateKeyCiphertextBlob is automatically base64 encoded/decoded by the SDK.
    PrivateKeyCiphertextBlob []byte `min:"1" type:"blob"`

    // The public key (in plaintext).
    //
    // PublicKey is automatically base64 encoded/decoded by the SDK.
    PublicKey []byte `min:"1" type:"blob"`
    // contains filtered or unexported fields
}

func (GenerateDataKeyPairWithoutPlaintextOutput) GoString

func (s GenerateDataKeyPairWithoutPlaintextOutput) GoString() string

GoString returns the string representation

func (*GenerateDataKeyPairWithoutPlaintextOutput) SetKeyId

func (s *GenerateDataKeyPairWithoutPlaintextOutput) SetKeyId(v string) *GenerateDataKeyPairWithoutPlaintextOutput

SetKeyId sets the KeyId field's value.

func (*GenerateDataKeyPairWithoutPlaintextOutput) SetKeyPairSpec

func (s *GenerateDataKeyPairWithoutPlaintextOutput) SetKeyPairSpec(v string) *GenerateDataKeyPairWithoutPlaintextOutput

SetKeyPairSpec sets the KeyPairSpec field's value.

func (*GenerateDataKeyPairWithoutPlaintextOutput) SetPrivateKeyCiphertextBlob

func (s *GenerateDataKeyPairWithoutPlaintextOutput) SetPrivateKeyCiphertextBlob(v []byte) *GenerateDataKeyPairWithoutPlaintextOutput

SetPrivateKeyCiphertextBlob sets the PrivateKeyCiphertextBlob field's value.

func (*GenerateDataKeyPairWithoutPlaintextOutput) SetPublicKey

func (s *GenerateDataKeyPairWithoutPlaintextOutput) SetPublicKey(v []byte) *GenerateDataKeyPairWithoutPlaintextOutput

SetPublicKey sets the PublicKey field's value.

func (GenerateDataKeyPairWithoutPlaintextOutput) String

func (s GenerateDataKeyPairWithoutPlaintextOutput) String() string

String returns the string representation

type GenerateDataKeyWithoutPlaintextInput

type GenerateDataKeyWithoutPlaintextInput struct {

    // Specifies the encryption context that will be used when encrypting the data
    // key.
    //
    // An encryption context is a collection of non-secret key-value pairs that
    // represents additional authenticated data. When you use an encryption context
    // to encrypt data, you must specify the same (an exact case-sensitive match)
    // encryption context to decrypt the data. An encryption context is optional
    // when encrypting with a symmetric CMK, but it is highly recommended.
    //
    // For more information, see Encryption Context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context)
    // in the AWS Key Management Service Developer Guide.
    EncryptionContext map[string]*string `type:"map"`

    // A list of grant tokens.
    //
    // For more information, see Grant Tokens (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token)
    // in the AWS Key Management Service Developer Guide.
    GrantTokens []*string `type:"list"`

    // The identifier of the symmetric customer master key (CMK) that encrypts the
    // data key.
    //
    // To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name,
    // or alias ARN. When using an alias name, prefix it with "alias/". To specify
    // a CMK in a different AWS account, you must use the key ARN or alias ARN.
    //
    // For example:
    //
    //    * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    //
    //    * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    //
    //    * Alias name: alias/ExampleAlias
    //
    //    * Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
    //
    // To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To
    // get the alias name and alias ARN, use ListAliases.
    //
    // KeyId is a required field
    KeyId *string `min:"1" type:"string" required:"true"`

    // The length of the data key. Use AES_128 to generate a 128-bit symmetric key,
    // or AES_256 to generate a 256-bit symmetric key.
    KeySpec *string `type:"string" enum:"DataKeySpec"`

    // The length of the data key in bytes. For example, use the value 64 to generate
    // a 512-bit data key (64 bytes is 512 bits). For common key lengths (128-bit
    // and 256-bit symmetric keys), we recommend that you use the KeySpec field
    // instead of this one.
    NumberOfBytes *int64 `min:"1" type:"integer"`
    // contains filtered or unexported fields
}

func (GenerateDataKeyWithoutPlaintextInput) GoString

func (s GenerateDataKeyWithoutPlaintextInput) GoString() string

GoString returns the string representation

func (*GenerateDataKeyWithoutPlaintextInput) SetEncryptionContext

func (s *GenerateDataKeyWithoutPlaintextInput) SetEncryptionContext(v map[string]*string) *GenerateDataKeyWithoutPlaintextInput

SetEncryptionContext sets the EncryptionContext field's value.

func (*GenerateDataKeyWithoutPlaintextInput) SetGrantTokens

func (s *GenerateDataKeyWithoutPlaintextInput) SetGrantTokens(v []*string) *GenerateDataKeyWithoutPlaintextInput

SetGrantTokens sets the GrantTokens field's value.

func (*GenerateDataKeyWithoutPlaintextInput) SetKeyId

func (s *GenerateDataKeyWithoutPlaintextInput) SetKeyId(v string) *GenerateDataKeyWithoutPlaintextInput

SetKeyId sets the KeyId field's value.

func (*GenerateDataKeyWithoutPlaintextInput) SetKeySpec

func (s *GenerateDataKeyWithoutPlaintextInput) SetKeySpec(v string) *GenerateDataKeyWithoutPlaintextInput

SetKeySpec sets the KeySpec field's value.

func (*GenerateDataKeyWithoutPlaintextInput) SetNumberOfBytes

func (s *GenerateDataKeyWithoutPlaintextInput) SetNumberOfBytes(v int64) *GenerateDataKeyWithoutPlaintextInput

SetNumberOfBytes sets the NumberOfBytes field's value.

func (GenerateDataKeyWithoutPlaintextInput) String

func (s GenerateDataKeyWithoutPlaintextInput) String() string

String returns the string representation

func (*GenerateDataKeyWithoutPlaintextInput) Validate

func (s *GenerateDataKeyWithoutPlaintextInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GenerateDataKeyWithoutPlaintextOutput

type GenerateDataKeyWithoutPlaintextOutput struct {

    // The encrypted data key. When you use the HTTP API or the AWS CLI, the value
    // is Base64-encoded. Otherwise, it is not Base64-encoded.
    //
    // CiphertextBlob is automatically base64 encoded/decoded by the SDK.
    CiphertextBlob []byte `min:"1" type:"blob"`

    // The Amazon Resource Name (key ARN (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN))
    // of the CMK that encrypted the data key.
    KeyId *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (GenerateDataKeyWithoutPlaintextOutput) GoString

func (s GenerateDataKeyWithoutPlaintextOutput) GoString() string

GoString returns the string representation

func (*GenerateDataKeyWithoutPlaintextOutput) SetCiphertextBlob

func (s *GenerateDataKeyWithoutPlaintextOutput) SetCiphertextBlob(v []byte) *GenerateDataKeyWithoutPlaintextOutput

SetCiphertextBlob sets the CiphertextBlob field's value.

func (*GenerateDataKeyWithoutPlaintextOutput) SetKeyId

func (s *GenerateDataKeyWithoutPlaintextOutput) SetKeyId(v string) *GenerateDataKeyWithoutPlaintextOutput

SetKeyId sets the KeyId field's value.

func (GenerateDataKeyWithoutPlaintextOutput) String

func (s GenerateDataKeyWithoutPlaintextOutput) String() string

String returns the string representation

type GenerateRandomInput

type GenerateRandomInput struct {

    // Generates the random byte string in the AWS CloudHSM cluster that is associated
    // with the specified custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html).
    // To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
    CustomKeyStoreId *string `min:"1" type:"string"`

    // The length of the byte string.
    NumberOfBytes *int64 `min:"1" type:"integer"`
    // contains filtered or unexported fields
}

func (GenerateRandomInput) GoString

func (s GenerateRandomInput) GoString() string

GoString returns the string representation

func (*GenerateRandomInput) SetCustomKeyStoreId

func (s *GenerateRandomInput) SetCustomKeyStoreId(v string) *GenerateRandomInput

SetCustomKeyStoreId sets the CustomKeyStoreId field's value.

func (*GenerateRandomInput) SetNumberOfBytes

func (s *GenerateRandomInput) SetNumberOfBytes(v int64) *GenerateRandomInput

SetNumberOfBytes sets the NumberOfBytes field's value.

func (GenerateRandomInput) String

func (s GenerateRandomInput) String() string

String returns the string representation

func (*GenerateRandomInput) Validate

func (s *GenerateRandomInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GenerateRandomOutput

type GenerateRandomOutput struct {

    // The random byte string. When you use the HTTP API or the AWS CLI, the value
    // is Base64-encoded. Otherwise, it is not Base64-encoded.
    //
    // Plaintext is automatically base64 encoded/decoded by the SDK.
    Plaintext []byte `min:"1" type:"blob" sensitive:"true"`
    // contains filtered or unexported fields
}

func (GenerateRandomOutput) GoString

func (s GenerateRandomOutput) GoString() string

GoString returns the string representation

func (*GenerateRandomOutput) SetPlaintext

func (s *GenerateRandomOutput) SetPlaintext(v []byte) *GenerateRandomOutput

SetPlaintext sets the Plaintext field's value.

func (GenerateRandomOutput) String

func (s GenerateRandomOutput) String() string

String returns the string representation

type GetKeyPolicyInput

type GetKeyPolicyInput struct {

    // A unique identifier for the customer master key (CMK).
    //
    // Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
    //
    // For example:
    //
    //    * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    //
    //    * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    //
    // To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
    //
    // KeyId is a required field
    KeyId *string `min:"1" type:"string" required:"true"`

    // Specifies the name of the key policy. The only valid name is default. To
    // get the names of key policies, use ListKeyPolicies.
    //
    // PolicyName is a required field
    PolicyName *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (GetKeyPolicyInput) GoString

func (s GetKeyPolicyInput) GoString() string

GoString returns the string representation

func (*GetKeyPolicyInput) SetKeyId

func (s *GetKeyPolicyInput) SetKeyId(v string) *GetKeyPolicyInput

SetKeyId sets the KeyId field's value.

func (*GetKeyPolicyInput) SetPolicyName

func (s *GetKeyPolicyInput) SetPolicyName(v string) *GetKeyPolicyInput

SetPolicyName sets the PolicyName field's value.

func (GetKeyPolicyInput) String

func (s GetKeyPolicyInput) String() string

String returns the string representation

func (*GetKeyPolicyInput) Validate

func (s *GetKeyPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetKeyPolicyOutput

type GetKeyPolicyOutput struct {

    // A key policy document in JSON format.
    Policy *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (GetKeyPolicyOutput) GoString

func (s GetKeyPolicyOutput) GoString() string

GoString returns the string representation

func (*GetKeyPolicyOutput) SetPolicy

func (s *GetKeyPolicyOutput) SetPolicy(v string) *GetKeyPolicyOutput

SetPolicy sets the Policy field's value.

func (GetKeyPolicyOutput) String

func (s GetKeyPolicyOutput) String() string

String returns the string representation

type GetKeyRotationStatusInput

type GetKeyRotationStatusInput struct {

    // A unique identifier for the customer master key (CMK).
    //
    // Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify
    // a CMK in a different AWS account, you must use the key ARN.
    //
    // For example:
    //
    //    * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    //
    //    * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    //
    // To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
    //
    // KeyId is a required field
    KeyId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (GetKeyRotationStatusInput) GoString

func (s GetKeyRotationStatusInput) GoString() string

GoString returns the string representation

func (*GetKeyRotationStatusInput) SetKeyId

func (s *GetKeyRotationStatusInput) SetKeyId(v string) *GetKeyRotationStatusInput

SetKeyId sets the KeyId field's value.

func (GetKeyRotationStatusInput) String

func (s GetKeyRotationStatusInput) String() string

String returns the string representation

func (*GetKeyRotationStatusInput) Validate

func (s *GetKeyRotationStatusInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetKeyRotationStatusOutput

type GetKeyRotationStatusOutput struct {

    // A Boolean value that specifies whether key rotation is enabled.
    KeyRotationEnabled *bool `type:"boolean"`
    // contains filtered or unexported fields
}

func (GetKeyRotationStatusOutput) GoString

func (s GetKeyRotationStatusOutput) GoString() string

GoString returns the string representation

func (*GetKeyRotationStatusOutput) SetKeyRotationEnabled

func (s *GetKeyRotationStatusOutput) SetKeyRotationEnabled(v bool) *GetKeyRotationStatusOutput

SetKeyRotationEnabled sets the KeyRotationEnabled field's value.

func (GetKeyRotationStatusOutput) String

func (s GetKeyRotationStatusOutput) String() string

String returns the string representation

type GetParametersForImportInput

type GetParametersForImportInput struct {

    // The identifier of the symmetric CMK into which you will import key material.
    // The Origin of the CMK must be EXTERNAL.
    //
    // Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
    //
    // For example:
    //
    //    * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    //
    //    * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    //
    // To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
    //
    // KeyId is a required field
    KeyId *string `min:"1" type:"string" required:"true"`

    // The algorithm you will use to encrypt the key material before importing it
    // with ImportKeyMaterial. For more information, see Encrypt the Key Material
    // (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-encrypt-key-material.html)
    // in the AWS Key Management Service Developer Guide.
    //
    // WrappingAlgorithm is a required field
    WrappingAlgorithm *string `type:"string" required:"true" enum:"AlgorithmSpec"`

    // The type of wrapping key (public key) to return in the response. Only 2048-bit
    // RSA public keys are supported.
    //
    // WrappingKeySpec is a required field
    WrappingKeySpec *string `type:"string" required:"true" enum:"WrappingKeySpec"`
    // contains filtered or unexported fields
}

func (GetParametersForImportInput) GoString

func (s GetParametersForImportInput) GoString() string

GoString returns the string representation

func (*GetParametersForImportInput) SetKeyId

func (s *GetParametersForImportInput) SetKeyId(v string) *GetParametersForImportInput

SetKeyId sets the KeyId field's value.

func (*GetParametersForImportInput) SetWrappingAlgorithm

func (s *GetParametersForImportInput) SetWrappingAlgorithm(v string) *GetParametersForImportInput

SetWrappingAlgorithm sets the WrappingAlgorithm field's value.

func (*GetParametersForImportInput) SetWrappingKeySpec

func (s *GetParametersForImportInput) SetWrappingKeySpec(v string) *GetParametersForImportInput

SetWrappingKeySpec sets the WrappingKeySpec field's value.

func (GetParametersForImportInput) String

func (s GetParametersForImportInput) String() string

String returns the string representation

func (*GetParametersForImportInput) Validate

func (s *GetParametersForImportInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetParametersForImportOutput

type GetParametersForImportOutput struct {

    // The import token to send in a subsequent ImportKeyMaterial request.
    //
    // ImportToken is automatically base64 encoded/decoded by the SDK.
    ImportToken []byte `min:"1" type:"blob"`

    // The Amazon Resource Name (key ARN (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN))
    // of the CMK to use in a subsequent ImportKeyMaterial request. This is the
    // same CMK specified in the GetParametersForImport request.
    KeyId *string `min:"1" type:"string"`

    // The time at which the import token and public key are no longer valid. After
    // this time, you cannot use them to make an ImportKeyMaterial request and you
    // must send another GetParametersForImport request to get new ones.
    ParametersValidTo *time.Time `type:"timestamp"`

    // The public key to use to encrypt the key material before importing it with
    // ImportKeyMaterial.
    //
    // PublicKey is automatically base64 encoded/decoded by the SDK.
    PublicKey []byte `min:"1" type:"blob" sensitive:"true"`
    // contains filtered or unexported fields
}

func (GetParametersForImportOutput) GoString

func (s GetParametersForImportOutput) GoString() string

GoString returns the string representation

func (*GetParametersForImportOutput) SetImportToken

func (s *GetParametersForImportOutput) SetImportToken(v []byte) *GetParametersForImportOutput

SetImportToken sets the ImportToken field's value.

func (*GetParametersForImportOutput) SetKeyId

func (s *GetParametersForImportOutput) SetKeyId(v string) *GetParametersForImportOutput

SetKeyId sets the KeyId field's value.

func (*GetParametersForImportOutput) SetParametersValidTo

func (s *GetParametersForImportOutput) SetParametersValidTo(v time.Time) *GetParametersForImportOutput

SetParametersValidTo sets the ParametersValidTo field's value.

func (*GetParametersForImportOutput) SetPublicKey

func (s *GetParametersForImportOutput) SetPublicKey(v []byte) *GetParametersForImportOutput

SetPublicKey sets the PublicKey field's value.

func (GetParametersForImportOutput) String

func (s GetParametersForImportOutput) String() string

String returns the string representation

type GetPublicKeyInput

type GetPublicKeyInput struct {

    // A list of grant tokens.
    //
    // For more information, see Grant Tokens (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token)
    // in the AWS Key Management Service Developer Guide.
    GrantTokens []*string `type:"list"`

    // Identifies the asymmetric CMK that includes the public key.
    //
    // To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name,
    // or alias ARN. When using an alias name, prefix it with "alias/". To specify
    // a CMK in a different AWS account, you must use the key ARN or alias ARN.
    //
    // For example:
    //
    //    * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    //
    //    * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    //
    //    * Alias name: alias/ExampleAlias
    //
    //    * Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
    //
    // To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To
    // get the alias name and alias ARN, use ListAliases.
    //
    // KeyId is a required field
    KeyId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (GetPublicKeyInput) GoString

func (s GetPublicKeyInput) GoString() string

GoString returns the string representation

func (*GetPublicKeyInput) SetGrantTokens

func (s *GetPublicKeyInput) SetGrantTokens(v []*string) *GetPublicKeyInput

SetGrantTokens sets the GrantTokens field's value.

func (*GetPublicKeyInput) SetKeyId

func (s *GetPublicKeyInput) SetKeyId(v string) *GetPublicKeyInput

SetKeyId sets the KeyId field's value.

func (GetPublicKeyInput) String

func (s GetPublicKeyInput) String() string

String returns the string representation

func (*GetPublicKeyInput) Validate

func (s *GetPublicKeyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetPublicKeyOutput

type GetPublicKeyOutput struct {

    // The type of the of the public key that was downloaded.
    CustomerMasterKeySpec *string `type:"string" enum:"CustomerMasterKeySpec"`

    // The encryption algorithms that AWS KMS supports for this key.
    //
    // This information is critical. If a public key encrypts data outside of AWS
    // KMS by using an unsupported encryption algorithm, the ciphertext cannot be
    // decrypted.
    //
    // This field appears in the response only when the KeyUsage of the public key
    // is ENCRYPT_DECRYPT.
    EncryptionAlgorithms []*string `type:"list"`

    // The Amazon Resource Name (key ARN (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN))
    // of the asymmetric CMK from which the public key was downloaded.
    KeyId *string `min:"1" type:"string"`

    // The permitted use of the public key. Valid values are ENCRYPT_DECRYPT or
    // SIGN_VERIFY.
    //
    // This information is critical. If a public key with SIGN_VERIFY key usage
    // encrypts data outside of AWS KMS, the ciphertext cannot be decrypted.
    KeyUsage *string `type:"string" enum:"KeyUsageType"`

    // The exported public key.
    //
    // The value is a DER-encoded X.509 public key, also known as SubjectPublicKeyInfo
    // (SPKI), as defined in RFC 5280 (https://tools.ietf.org/html/rfc5280). When
    // you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise,
    // it is not Base64-encoded.
    //
    // PublicKey is automatically base64 encoded/decoded by the SDK.
    PublicKey []byte `min:"1" type:"blob"`

    // The signing algorithms that AWS KMS supports for this key.
    //
    // This field appears in the response only when the KeyUsage of the public key
    // is SIGN_VERIFY.
    SigningAlgorithms []*string `type:"list"`
    // contains filtered or unexported fields
}

func (GetPublicKeyOutput) GoString

func (s GetPublicKeyOutput) GoString() string

GoString returns the string representation

func (*GetPublicKeyOutput) SetCustomerMasterKeySpec

func (s *GetPublicKeyOutput) SetCustomerMasterKeySpec(v string) *GetPublicKeyOutput

SetCustomerMasterKeySpec sets the CustomerMasterKeySpec field's value.

func (*GetPublicKeyOutput) SetEncryptionAlgorithms

func (s *GetPublicKeyOutput) SetEncryptionAlgorithms(v []*string) *GetPublicKeyOutput

SetEncryptionAlgorithms sets the EncryptionAlgorithms field's value.

func (*GetPublicKeyOutput) SetKeyId

func (s *GetPublicKeyOutput) SetKeyId(v string) *GetPublicKeyOutput

SetKeyId sets the KeyId field's value.

func (*GetPublicKeyOutput) SetKeyUsage

func (s *GetPublicKeyOutput) SetKeyUsage(v string) *GetPublicKeyOutput

SetKeyUsage sets the KeyUsage field's value.

func (*GetPublicKeyOutput) SetPublicKey

func (s *GetPublicKeyOutput) SetPublicKey(v []byte) *GetPublicKeyOutput

SetPublicKey sets the PublicKey field's value.

func (*GetPublicKeyOutput) SetSigningAlgorithms

func (s *GetPublicKeyOutput) SetSigningAlgorithms(v []*string) *GetPublicKeyOutput

SetSigningAlgorithms sets the SigningAlgorithms field's value.

func (GetPublicKeyOutput) String

func (s GetPublicKeyOutput) String() string

String returns the string representation

type GrantConstraints

type GrantConstraints struct {

    // A list of key-value pairs that must match the encryption context in the cryptographic
    // operation (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations)
    // request. The grant allows the operation only when the encryption context
    // in the request is the same as the encryption context specified in this constraint.
    EncryptionContextEquals map[string]*string `type:"map"`

    // A list of key-value pairs that must be included in the encryption context
    // of the cryptographic operation (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations)
    // request. The grant allows the cryptographic operation only when the encryption
    // context in the request includes the key-value pairs specified in this constraint,
    // although it can include additional key-value pairs.
    EncryptionContextSubset map[string]*string `type:"map"`
    // contains filtered or unexported fields
}

Use this structure to allow cryptographic operations (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) in the grant only when the operation request includes the specified encryption context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context).

AWS KMS applies the grant constraints only to cryptographic operations that support an encryption context, that is, all cryptographic operations with a symmetric CMK (https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html#symmetric-cmks). Grant constraints are not applied to operations that do not support an encryption context, such as cryptographic operations with asymmetric CMKs and management operations, such as DescribeKey or ScheduleKeyDeletion.

In a cryptographic operation, the encryption context in the decryption operation must be an exact, case-sensitive match for the keys and values in the encryption context of the encryption operation. Only the order of the pairs can vary.

However, in a grant constraint, the key in each key-value pair is not case sensitive, but the value is case sensitive.

To avoid confusion, do not use multiple encryption context pairs that differ only by case. To require a fully case-sensitive encryption context, use the kms:EncryptionContext: and kms:EncryptionContextKeys conditions in an IAM or key policy. For details, see kms:EncryptionContext: (https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-encryption-context) in the AWS Key Management Service Developer Guide .

func (GrantConstraints) GoString

func (s GrantConstraints) GoString() string

GoString returns the string representation

func (*GrantConstraints) SetEncryptionContextEquals

func (s *GrantConstraints) SetEncryptionContextEquals(v map[string]*string) *GrantConstraints

SetEncryptionContextEquals sets the EncryptionContextEquals field's value.

func (*GrantConstraints) SetEncryptionContextSubset

func (s *GrantConstraints) SetEncryptionContextSubset(v map[string]*string) *GrantConstraints

SetEncryptionContextSubset sets the EncryptionContextSubset field's value.

func (GrantConstraints) String

func (s GrantConstraints) String() string

String returns the string representation

type GrantListEntry

type GrantListEntry struct {

    // A list of key-value pairs that must be present in the encryption context
    // of certain subsequent operations that the grant allows.
    Constraints *GrantConstraints `type:"structure"`

    // The date and time when the grant was created.
    CreationDate *time.Time `type:"timestamp"`

    // The unique identifier for the grant.
    GrantId *string `min:"1" type:"string"`

    // The identity that gets the permissions in the grant.
    //
    // The GranteePrincipal field in the ListGrants response usually contains the
    // user or role designated as the grantee principal in the grant. However, when
    // the grantee principal in the grant is an AWS service, the GranteePrincipal
    // field contains the service principal (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services),
    // which might represent several different grantee principals.
    GranteePrincipal *string `min:"1" type:"string"`

    // The AWS account under which the grant was issued.
    IssuingAccount *string `min:"1" type:"string"`

    // The unique identifier for the customer master key (CMK) to which the grant
    // applies.
    KeyId *string `min:"1" type:"string"`

    // The friendly name that identifies the grant. If a name was provided in the
    // CreateGrant request, that name is returned. Otherwise this value is null.
    Name *string `min:"1" type:"string"`

    // The list of operations permitted by the grant.
    Operations []*string `type:"list"`

    // The principal that can retire the grant.
    RetiringPrincipal *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

Contains information about a grant.

func (GrantListEntry) GoString

func (s GrantListEntry) GoString() string

GoString returns the string representation

func (*GrantListEntry) SetConstraints

func (s *GrantListEntry) SetConstraints(v *GrantConstraints) *GrantListEntry

SetConstraints sets the Constraints field's value.

func (*GrantListEntry) SetCreationDate

func (s *GrantListEntry) SetCreationDate(v time.Time) *GrantListEntry

SetCreationDate sets the CreationDate field's value.

func (*GrantListEntry) SetGrantId

func (s *GrantListEntry) SetGrantId(v string) *GrantListEntry

SetGrantId sets the GrantId field's value.

func (*GrantListEntry) SetGranteePrincipal

func (s *GrantListEntry) SetGranteePrincipal(v string) *GrantListEntry

SetGranteePrincipal sets the GranteePrincipal field's value.

func (*GrantListEntry) SetIssuingAccount

func (s *GrantListEntry) SetIssuingAccount(v string) *GrantListEntry

SetIssuingAccount sets the IssuingAccount field's value.

func (*GrantListEntry) SetKeyId

func (s *GrantListEntry) SetKeyId(v string) *GrantListEntry

SetKeyId sets the KeyId field's value.

func (*GrantListEntry) SetName

func (s *GrantListEntry) SetName(v string) *GrantListEntry

SetName sets the Name field's value.

func (*GrantListEntry) SetOperations

func (s *GrantListEntry) SetOperations(v []*string) *GrantListEntry

SetOperations sets the Operations field's value.

func (*GrantListEntry) SetRetiringPrincipal

func (s *GrantListEntry) SetRetiringPrincipal(v string) *GrantListEntry

SetRetiringPrincipal sets the RetiringPrincipal field's value.

func (GrantListEntry) String

func (s GrantListEntry) String() string

String returns the string representation

type ImportKeyMaterialInput

type ImportKeyMaterialInput struct {

    // The encrypted key material to import. The key material must be encrypted
    // with the public wrapping key that GetParametersForImport returned, using
    // the wrapping algorithm that you specified in the same GetParametersForImport
    // request.
    //
    // EncryptedKeyMaterial is automatically base64 encoded/decoded by the SDK.
    //
    // EncryptedKeyMaterial is a required field
    EncryptedKeyMaterial []byte `min:"1" type:"blob" required:"true"`

    // Specifies whether the key material expires. The default is KEY_MATERIAL_EXPIRES,
    // in which case you must include the ValidTo parameter. When this parameter
    // is set to KEY_MATERIAL_DOES_NOT_EXPIRE, you must omit the ValidTo parameter.
    ExpirationModel *string `type:"string" enum:"ExpirationModelType"`

    // The import token that you received in the response to a previous GetParametersForImport
    // request. It must be from the same response that contained the public key
    // that you used to encrypt the key material.
    //
    // ImportToken is automatically base64 encoded/decoded by the SDK.
    //
    // ImportToken is a required field
    ImportToken []byte `min:"1" type:"blob" required:"true"`

    // The identifier of the symmetric CMK that receives the imported key material.
    // The CMK's Origin must be EXTERNAL. This must be the same CMK specified in
    // the KeyID parameter of the corresponding GetParametersForImport request.
    //
    // Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
    //
    // For example:
    //
    //    * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    //
    //    * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    //
    // To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
    //
    // KeyId is a required field
    KeyId *string `min:"1" type:"string" required:"true"`

    // The time at which the imported key material expires. When the key material
    // expires, AWS KMS deletes the key material and the CMK becomes unusable. You
    // must omit this parameter when the ExpirationModel parameter is set to KEY_MATERIAL_DOES_NOT_EXPIRE.
    // Otherwise it is required.
    ValidTo *time.Time `type:"timestamp"`
    // contains filtered or unexported fields
}

func (ImportKeyMaterialInput) GoString

func (s ImportKeyMaterialInput) GoString() string

GoString returns the string representation

func (*ImportKeyMaterialInput) SetEncryptedKeyMaterial

func (s *ImportKeyMaterialInput) SetEncryptedKeyMaterial(v []byte) *ImportKeyMaterialInput

SetEncryptedKeyMaterial sets the EncryptedKeyMaterial field's value.

func (*ImportKeyMaterialInput) SetExpirationModel

func (s *ImportKeyMaterialInput) SetExpirationModel(v string) *ImportKeyMaterialInput

SetExpirationModel sets the ExpirationModel field's value.

func (*ImportKeyMaterialInput) SetImportToken

func (s *ImportKeyMaterialInput) SetImportToken(v []byte) *ImportKeyMaterialInput

SetImportToken sets the ImportToken field's value.

func (*ImportKeyMaterialInput) SetKeyId

func (s *ImportKeyMaterialInput) SetKeyId(v string) *ImportKeyMaterialInput

SetKeyId sets the KeyId field's value.

func (*ImportKeyMaterialInput) SetValidTo

func (s *ImportKeyMaterialInput) SetValidTo(v time.Time) *ImportKeyMaterialInput

SetValidTo sets the ValidTo field's value.

func (ImportKeyMaterialInput) String

func (s ImportKeyMaterialInput) String() string

String returns the string representation

func (*ImportKeyMaterialInput) Validate

func (s *ImportKeyMaterialInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ImportKeyMaterialOutput

type ImportKeyMaterialOutput struct {
    // contains filtered or unexported fields
}

func (ImportKeyMaterialOutput) GoString

func (s ImportKeyMaterialOutput) GoString() string

GoString returns the string representation

func (ImportKeyMaterialOutput) String

func (s ImportKeyMaterialOutput) String() string

String returns the string representation

type IncorrectKeyException

type IncorrectKeyException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

The request was rejected because the specified CMK cannot decrypt the data. The KeyId in a Decrypt request and the SourceKeyId in a ReEncrypt request must identify the same CMK that was used to encrypt the ciphertext.

func (*IncorrectKeyException) Code

func (s *IncorrectKeyException) Code() string

Code returns the exception type name.

func (*IncorrectKeyException) Error

func (s *IncorrectKeyException) Error() string

func (IncorrectKeyException) GoString

func (s IncorrectKeyException) GoString() string

GoString returns the string representation

func (*IncorrectKeyException) Message

func (s *IncorrectKeyException) Message() string

Message returns the exception's message.

func (*IncorrectKeyException) OrigErr

func (s *IncorrectKeyException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*IncorrectKeyException) RequestID

func (s *IncorrectKeyException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*IncorrectKeyException) StatusCode

func (s *IncorrectKeyException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (IncorrectKeyException) String

func (s IncorrectKeyException) String() string

String returns the string representation

type IncorrectKeyMaterialException

type IncorrectKeyMaterialException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

The request was rejected because the key material in the request is, expired, invalid, or is not the same key material that was previously imported into this customer master key (CMK).

func (*IncorrectKeyMaterialException) Code

func (s *IncorrectKeyMaterialException) Code() string

Code returns the exception type name.

func (*IncorrectKeyMaterialException) Error

func (s *IncorrectKeyMaterialException) Error() string

func (IncorrectKeyMaterialException) GoString

func (s IncorrectKeyMaterialException) GoString() string

GoString returns the string representation

func (*IncorrectKeyMaterialException) Message

func (s *IncorrectKeyMaterialException) Message() string

Message returns the exception's message.

func (*IncorrectKeyMaterialException) OrigErr

func (s *IncorrectKeyMaterialException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*IncorrectKeyMaterialException) RequestID

func (s *IncorrectKeyMaterialException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*IncorrectKeyMaterialException) StatusCode

func (s *IncorrectKeyMaterialException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (IncorrectKeyMaterialException) String

func (s IncorrectKeyMaterialException) String() string

String returns the string representation

type IncorrectTrustAnchorException

type IncorrectTrustAnchorException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

The request was rejected because the trust anchor certificate in the request is not the trust anchor certificate for the specified AWS CloudHSM cluster.

When you initialize the cluster (https://docs.aws.amazon.com/cloudhsm/latest/userguide/initialize-cluster.html#sign-csr), you create the trust anchor certificate and save it in the customerCA.crt file.

func (*IncorrectTrustAnchorException) Code

func (s *IncorrectTrustAnchorException) Code() string

Code returns the exception type name.

func (*IncorrectTrustAnchorException) Error

func (s *IncorrectTrustAnchorException) Error() string

func (IncorrectTrustAnchorException) GoString

func (s IncorrectTrustAnchorException) GoString() string

GoString returns the string representation

func (*IncorrectTrustAnchorException) Message

func (s *IncorrectTrustAnchorException) Message() string

Message returns the exception's message.

func (*IncorrectTrustAnchorException) OrigErr

func (s *IncorrectTrustAnchorException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*IncorrectTrustAnchorException) RequestID

func (s *IncorrectTrustAnchorException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*IncorrectTrustAnchorException) StatusCode

func (s *IncorrectTrustAnchorException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (IncorrectTrustAnchorException) String

func (s IncorrectTrustAnchorException) String() string

String returns the string representation

type InternalException

type InternalException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

The request was rejected because an internal exception occurred. The request can be retried.

func (*InternalException) Code

func (s *InternalException) Code() string

Code returns the exception type name.

func (*InternalException) Error

func (s *InternalException) Error() string

func (InternalException) GoString

func (s InternalException) GoString() string

GoString returns the string representation

func (*InternalException) Message

func (s *InternalException) Message() string

Message returns the exception's message.

func (*InternalException) OrigErr

func (s *InternalException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalException) RequestID

func (s *InternalException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalException) StatusCode

func (s *InternalException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalException) String

func (s InternalException) String() string

String returns the string representation

type InvalidAliasNameException

type InvalidAliasNameException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

The request was rejected because the specified alias name is not valid.

func (*InvalidAliasNameException) Code

func (s *InvalidAliasNameException) Code() string

Code returns the exception type name.

func (*InvalidAliasNameException) Error

func (s *InvalidAliasNameException) Error() string

func (InvalidAliasNameException) GoString

func (s InvalidAliasNameException) GoString() string

GoString returns the string representation

func (*InvalidAliasNameException) Message

func (s *InvalidAliasNameException) Message() string

Message returns the exception's message.

func (*InvalidAliasNameException) OrigErr

func (s *InvalidAliasNameException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidAliasNameException) RequestID

func (s *InvalidAliasNameException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidAliasNameException) StatusCode

func (s *InvalidAliasNameException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidAliasNameException) String

func (s InvalidAliasNameException) String() string

String returns the string representation

type InvalidArnException

type InvalidArnException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.

func (*InvalidArnException) Code

func (s *InvalidArnException) Code() string

Code returns the exception type name.

func (*InvalidArnException) Error

func (s *InvalidArnException) Error() string

func (InvalidArnException) GoString

func (s InvalidArnException) GoString() string

GoString returns the string representation

func (*InvalidArnException) Message

func (s *InvalidArnException) Message() string

Message returns the exception's message.

func (*InvalidArnException) OrigErr

func (s *InvalidArnException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidArnException) RequestID

func (s *InvalidArnException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidArnException) StatusCode

func (s *InvalidArnException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidArnException) String

func (s InvalidArnException) String() string

String returns the string representation

type InvalidCiphertextException

type InvalidCiphertextException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

From the Decrypt or ReEncrypt operation, the request was rejected because the specified ciphertext, or additional authenticated data incorporated into the ciphertext, such as the encryption context, is corrupted, missing, or otherwise invalid.

From the ImportKeyMaterial operation, the request was rejected because AWS KMS could not decrypt the encrypted (wrapped) key material.

func (*InvalidCiphertextException) Code

func (s *InvalidCiphertextException) Code() string

Code returns the exception type name.

func (*InvalidCiphertextException) Error

func (s *InvalidCiphertextException) Error() string

func (InvalidCiphertextException) GoString

func (s InvalidCiphertextException) GoString() string

GoString returns the string representation

func (*InvalidCiphertextException) Message

func (s *InvalidCiphertextException) Message() string

Message returns the exception's message.

func (*InvalidCiphertextException) OrigErr

func (s *InvalidCiphertextException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidCiphertextException) RequestID

func (s *InvalidCiphertextException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidCiphertextException) StatusCode

func (s *InvalidCiphertextException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidCiphertextException) String

func (s InvalidCiphertextException) String() string

String returns the string representation

type InvalidGrantIdException

type InvalidGrantIdException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

The request was rejected because the specified GrantId is not valid.

func (*InvalidGrantIdException) Code

func (s *InvalidGrantIdException) Code() string

Code returns the exception type name.

func (*InvalidGrantIdException) Error

func (s *InvalidGrantIdException) Error() string

func (InvalidGrantIdException) GoString

func (s InvalidGrantIdException) GoString() string

GoString returns the string representation

func (*InvalidGrantIdException) Message

func (s *InvalidGrantIdException) Message() string

Message returns the exception's message.

func (*InvalidGrantIdException) OrigErr

func (s *InvalidGrantIdException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidGrantIdException) RequestID

func (s *InvalidGrantIdException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidGrantIdException) StatusCode

func (s *InvalidGrantIdException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidGrantIdException) String

func (s InvalidGrantIdException) String() string

String returns the string representation

type InvalidGrantTokenException

type InvalidGrantTokenException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

The request was rejected because the specified grant token is not valid.

func (*InvalidGrantTokenException) Code

func (s *InvalidGrantTokenException) Code() string

Code returns the exception type name.

func (*InvalidGrantTokenException) Error

func (s *InvalidGrantTokenException) Error() string

func (InvalidGrantTokenException) GoString

func (s InvalidGrantTokenException) GoString() string

GoString returns the string representation

func (*InvalidGrantTokenException) Message

func (s *InvalidGrantTokenException) Message() string

Message returns the exception's message.

func (*InvalidGrantTokenException) OrigErr

func (s *InvalidGrantTokenException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidGrantTokenException) RequestID

func (s *InvalidGrantTokenException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidGrantTokenException) StatusCode

func (s *InvalidGrantTokenException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidGrantTokenException) String

func (s InvalidGrantTokenException) String() string

String returns the string representation

type InvalidImportTokenException

type InvalidImportTokenException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

The request was rejected because the provided import token is invalid or is associated with a different customer master key (CMK).

func (*InvalidImportTokenException) Code

func (s *InvalidImportTokenException) Code() string

Code returns the exception type name.

func (*InvalidImportTokenException) Error

func (s *InvalidImportTokenException) Error() string

func (InvalidImportTokenException) GoString

func (s InvalidImportTokenException) GoString() string

GoString returns the string representation

func (*InvalidImportTokenException) Message

func (s *InvalidImportTokenException) Message() string

Message returns the exception's message.

func (*InvalidImportTokenException) OrigErr

func (s *InvalidImportTokenException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidImportTokenException) RequestID

func (s *InvalidImportTokenException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidImportTokenException) StatusCode

func (s *InvalidImportTokenException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidImportTokenException) String

func (s InvalidImportTokenException) String() string

String returns the string representation

type InvalidKeyUsageException

type InvalidKeyUsageException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

The request was rejected for one of the following reasons:

* The KeyUsage value of the CMK 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 CMK (CustomerMasterKeySpec).

For encrypting, decrypting, re-encrypting, and generating data keys, the KeyUsage must be ENCRYPT_DECRYPT. For signing and verifying, the KeyUsage must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation.

To find the encryption or signing algorithms supported for a particular CMK, use the DescribeKey operation.

func (*InvalidKeyUsageException) Code

func (s *InvalidKeyUsageException) Code() string

Code returns the exception type name.

func (*InvalidKeyUsageException) Error

func (s *InvalidKeyUsageException) Error() string

func (InvalidKeyUsageException) GoString

func (s InvalidKeyUsageException) GoString() string

GoString returns the string representation

func (*InvalidKeyUsageException) Message

func (s *InvalidKeyUsageException) Message() string

Message returns the exception's message.

func (*InvalidKeyUsageException) OrigErr

func (s *InvalidKeyUsageException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidKeyUsageException) RequestID

func (s *InvalidKeyUsageException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidKeyUsageException) StatusCode

func (s *InvalidKeyUsageException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidKeyUsageException) String

func (s InvalidKeyUsageException) String() string

String returns the string representation

type InvalidMarkerException

type InvalidMarkerException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

The request was rejected because the marker that specifies where pagination should next begin is not valid.

func (*InvalidMarkerException) Code

func (s *InvalidMarkerException) Code() string

Code returns the exception type name.

func (*InvalidMarkerException) Error

func (s *InvalidMarkerException) Error() string

func (InvalidMarkerException) GoString

func (s InvalidMarkerException) GoString() string

GoString returns the string representation

func (*InvalidMarkerException) Message

func (s *InvalidMarkerException) Message() string

Message returns the exception's message.

func (*InvalidMarkerException) OrigErr

func (s *InvalidMarkerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidMarkerException) RequestID

func (s *InvalidMarkerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidMarkerException) StatusCode

func (s *InvalidMarkerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidMarkerException) String

func (s InvalidMarkerException) String() string

String returns the string representation

type InvalidStateException

type InvalidStateException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

The request was rejected because the state of the specified resource is not valid for this request.

For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the AWS Key Management Service Developer Guide .

func (*InvalidStateException) Code

func (s *InvalidStateException) Code() string

Code returns the exception type name.

func (*InvalidStateException) Error

func (s *InvalidStateException) Error() string

func (InvalidStateException) GoString

func (s InvalidStateException) GoString() string

GoString returns the string representation

func (*InvalidStateException) Message

func (s *InvalidStateException) Message() string

Message returns the exception's message.

func (*InvalidStateException) OrigErr

func (s *InvalidStateException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidStateException) RequestID

func (s *InvalidStateException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidStateException) StatusCode

func (s *InvalidStateException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidStateException) String

func (s InvalidStateException) String() string

String returns the string representation

type KMS

type KMS struct {
    *client.Client
}

KMS provides the API operation methods for making requests to AWS Key Management Service. See this package's package overview docs for details on the service.

KMS methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(p client.ConfigProvider, cfgs ...*aws.Config) *KMS

New creates a new instance of the KMS client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

mySession := session.Must(session.NewSession())

// Create a KMS client from just a session.
svc := kms.New(mySession)

// Create a KMS client with additional configuration
svc := kms.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*KMS) CancelKeyDeletion

func (c *KMS) CancelKeyDeletion(input *CancelKeyDeletionInput) (*CancelKeyDeletionOutput, error)

CancelKeyDeletion API operation for AWS Key Management Service.

Cancels the deletion of a customer master key (CMK). When this operation succeeds, the key state of the CMK is Disabled. To enable the CMK, use EnableKey. You cannot perform this operation on a CMK in a different AWS account.

For more information about scheduling and canceling deletion of a CMK, see Deleting Customer Master Keys (https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) in the AWS Key Management Service Developer Guide.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the AWS Key Management Service Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation CancelKeyDeletion for usage and error information.

Returned Error Types:

* NotFoundException
The request was rejected because the specified entity or resource could not
be found.

* InvalidArnException
The request was rejected because a specified ARN, or an ARN in a key policy,
is not valid.

* DependencyTimeoutException
The system timed out while trying to fulfill the request. The request can
be retried.

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

* InvalidStateException
The request was rejected because the state of the specified resource is not
valid for this request.

For more information about how key state affects the use of a CMK, see How
Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html)
in the AWS Key Management Service Developer Guide .

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CancelKeyDeletion

Example (Shared00)

To cancel deletion of a customer master key (CMK) The following example cancels deletion of the specified CMK.

Code:

svc := kms.New(session.New())
input := &kms.CancelKeyDeletionInput{
    KeyId: aws.String("1234abcd-12ab-34cd-56ef-1234567890ab"),
}

result, err := svc.CancelKeyDeletion(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case kms.ErrCodeNotFoundException:
            fmt.Println(kms.ErrCodeNotFoundException, aerr.Error())
        case kms.ErrCodeInvalidArnException:
            fmt.Println(kms.ErrCodeInvalidArnException, aerr.Error())
        case kms.ErrCodeDependencyTimeoutException:
            fmt.Println(kms.ErrCodeDependencyTimeoutException, aerr.Error())
        case kms.ErrCodeInternalException:
            fmt.Println(kms.ErrCodeInternalException, aerr.Error())
        case kms.ErrCodeInvalidStateException:
            fmt.Println(kms.ErrCodeInvalidStateException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*KMS) CancelKeyDeletionRequest

func (c *KMS) CancelKeyDeletionRequest(input *CancelKeyDeletionInput) (req *request.Request, output *CancelKeyDeletionOutput)

CancelKeyDeletionRequest generates a "aws/request.Request" representing the client's request for the CancelKeyDeletion operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CancelKeyDeletion for more information on using the CancelKeyDeletion API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CancelKeyDeletionRequest method.
req, resp := client.CancelKeyDeletionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CancelKeyDeletion

func (*KMS) CancelKeyDeletionWithContext

func (c *KMS) CancelKeyDeletionWithContext(ctx aws.Context, input *CancelKeyDeletionInput, opts ...request.Option) (*CancelKeyDeletionOutput, error)

CancelKeyDeletionWithContext is the same as CancelKeyDeletion with the addition of the ability to pass a context and additional request options.

See CancelKeyDeletion for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) ConnectCustomKeyStore

func (c *KMS) ConnectCustomKeyStore(input *ConnectCustomKeyStoreInput) (*ConnectCustomKeyStoreOutput, error)

ConnectCustomKeyStore API operation for AWS Key Management Service.

Connects or reconnects a custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) to its associated AWS CloudHSM cluster.

The custom key store must be connected before you can create customer master keys (CMKs) in the key store or use the CMKs it contains. You can disconnect and reconnect a custom key store at any time.

To connect a custom key store, its associated AWS CloudHSM cluster must have at least one active HSM. To get the number of active HSMs in a cluster, use the DescribeClusters (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html) operation. To add HSMs to the cluster, use the CreateHsm (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_CreateHsm.html) operation. Also, the kmsuser crypto user (https://docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-kmsuser) (CU) must not be logged into the cluster. This prevents AWS KMS from using this account to log in.

The connection process can take an extended amount of time to complete; up to 20 minutes. This operation starts the connection process, but it does not wait for it to complete. When it succeeds, this operation quickly returns an HTTP 200 response and a JSON object with no properties. However, this response does not indicate that the custom key store is connected. To get the connection state of the custom key store, use the DescribeCustomKeyStores operation.

During the connection process, AWS KMS finds the AWS CloudHSM cluster that is associated with the custom key store, creates the connection infrastructure, connects to the cluster, logs into the AWS CloudHSM client as the kmsuser CU, and rotates its password.

The ConnectCustomKeyStore operation might fail for various reasons. To find the reason, use the DescribeCustomKeyStores operation and see the ConnectionErrorCode in the response. For help interpreting the ConnectionErrorCode, see CustomKeyStoresListEntry.

To fix the failure, use the DisconnectCustomKeyStore operation to disconnect the custom key store, correct the error, use the UpdateCustomKeyStore operation if necessary, and then use ConnectCustomKeyStore again.

If you are having trouble connecting or disconnecting a custom key store, see Troubleshooting a Custom Key Store (https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html) in the AWS Key Management Service Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation ConnectCustomKeyStore for usage and error information.

Returned Error Types:

* CloudHsmClusterNotActiveException
The request was rejected because the AWS CloudHSM cluster that is associated
with the custom key store is not active. Initialize and activate the cluster
and try the command again. For detailed instructions, see Getting Started
(https://docs.aws.amazon.com/cloudhsm/latest/userguide/getting-started.html)
in the AWS CloudHSM User Guide.

* CustomKeyStoreInvalidStateException
The request was rejected because of the ConnectionState of the custom key
store. To get the ConnectionState of a custom key store, use the DescribeCustomKeyStores
operation.

This exception is thrown under the following conditions:

   * You requested the CreateKey or GenerateRandom operation in a custom
   key store that is not connected. These operations are valid only when
   the custom key store ConnectionState is CONNECTED.

   * You requested the UpdateCustomKeyStore or DeleteCustomKeyStore operation
   on a custom key store that is not disconnected. This operation is valid
   only when the custom key store ConnectionState is DISCONNECTED.

   * You requested the ConnectCustomKeyStore operation on a custom key store
   with a ConnectionState of DISCONNECTING or FAILED. This operation is valid
   for all other ConnectionState values.

* CustomKeyStoreNotFoundException
The request was rejected because AWS KMS cannot find a custom key store with
the specified key store name or ID.

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

* CloudHsmClusterInvalidConfigurationException
The request was rejected because the associated AWS CloudHSM cluster did
not meet the configuration requirements for a custom key store.

   * The cluster must be configured with private subnets in at least two
   different Availability Zones in the Region.

   * The security group for the cluster (https://docs.aws.amazon.com/cloudhsm/latest/userguide/configure-sg.html)
   (cloudhsm-cluster-<cluster-id>-sg) must include inbound rules and outbound
   rules that allow TCP traffic on ports 2223-2225. The Source in the inbound
   rules and the Destination in the outbound rules must match the security
   group ID. These rules are set by default when you create the cluster.
   Do not delete or change them. To get information about a particular security
   group, use the DescribeSecurityGroups (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSecurityGroups.html)
   operation.

   * The cluster must contain at least as many HSMs as the operation requires.
   To add HSMs, use the AWS CloudHSM CreateHsm (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_CreateHsm.html)
   operation. For the CreateCustomKeyStore, UpdateCustomKeyStore, and CreateKey
   operations, the AWS CloudHSM cluster must have at least two active HSMs,
   each in a different Availability Zone. For the ConnectCustomKeyStore operation,
   the AWS CloudHSM must contain at least one active HSM.

For information about the requirements for an AWS CloudHSM cluster that is
associated with a custom key store, see Assemble the Prerequisites (https://docs.aws.amazon.com/kms/latest/developerguide/create-keystore.html#before-keystore)
in the AWS Key Management Service Developer Guide. For information about
creating a private subnet for an AWS CloudHSM cluster, see Create a Private
Subnet (https://docs.aws.amazon.com/cloudhsm/latest/userguide/create-subnets.html)
in the AWS CloudHSM User Guide. For information about cluster security groups,
see Configure a Default Security Group (https://docs.aws.amazon.com/cloudhsm/latest/userguide/configure-sg.html)
in the AWS CloudHSM User Guide .

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ConnectCustomKeyStore

func (*KMS) ConnectCustomKeyStoreRequest

func (c *KMS) ConnectCustomKeyStoreRequest(input *ConnectCustomKeyStoreInput) (req *request.Request, output *ConnectCustomKeyStoreOutput)

ConnectCustomKeyStoreRequest generates a "aws/request.Request" representing the client's request for the ConnectCustomKeyStore operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ConnectCustomKeyStore for more information on using the ConnectCustomKeyStore API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ConnectCustomKeyStoreRequest method.
req, resp := client.ConnectCustomKeyStoreRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ConnectCustomKeyStore

func (*KMS) ConnectCustomKeyStoreWithContext

func (c *KMS) ConnectCustomKeyStoreWithContext(ctx aws.Context, input *ConnectCustomKeyStoreInput, opts ...request.Option) (*ConnectCustomKeyStoreOutput, error)

ConnectCustomKeyStoreWithContext is the same as ConnectCustomKeyStore with the addition of the ability to pass a context and additional request options.

See ConnectCustomKeyStore for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) CreateAlias

func (c *KMS) CreateAlias(input *CreateAliasInput) (*CreateAliasOutput, error)

CreateAlias API operation for AWS Key Management Service.

Creates a display name for a customer managed customer master key (CMK). You can use an alias to identify a CMK in cryptographic operations (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations), such as Encrypt and GenerateDataKey. You can change the CMK associated with the alias at any time.

Aliases are easier to remember than key IDs. They can also help to simplify your applications. For example, if you use an alias in your code, you can change the CMK your code uses by associating a given alias with a different CMK.

To run the same code in multiple AWS regions, use an alias in your code, such as alias/ApplicationKey. Then, in each AWS Region, create an alias/ApplicationKey alias that is associated with a CMK in that Region. When you run your code, it uses the alias/ApplicationKey CMK for that AWS Region without any Region-specific code.

This operation does not return a response. To get the alias that you created, use the ListAliases operation.

To use aliases successfully, be aware of the following information.

* Each alias points to only one CMK at a time, although a single CMK can
have multiple aliases. The alias and its associated CMK must be in the
same AWS account and Region.

* You can associate an alias with any customer managed CMK in the same
AWS account and Region. However, you do not have permission to associate
an alias with an AWS managed CMK (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk)
or an AWS owned CMK (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk).

* To change the CMK associated with an alias, use the UpdateAlias operation.
The current CMK and the new CMK must be the same type (both symmetric
or both asymmetric) and they must have the same key usage (ENCRYPT_DECRYPT
or SIGN_VERIFY). This restriction prevents cryptographic errors in code
that uses aliases.

* The alias name must begin with alias/ followed by a name, such as alias/ExampleAlias.
It can contain only alphanumeric characters, forward slashes (/), underscores
(_), and dashes (-). The alias name cannot begin with alias/aws/. The
alias/aws/ prefix is reserved for AWS managed CMKs (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk).

* The alias name must be unique within an AWS Region. However, you can
use the same alias name in multiple Regions of the same AWS account. Each
instance of the alias is associated with a CMK in its Region.

* After you create an alias, you cannot change its alias name. However,
you can use the DeleteAlias operation to delete the alias and then create
a new alias with the desired name.

* You can use an alias name or alias ARN to identify a CMK in AWS KMS
cryptographic operations (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations)
and in the DescribeKey operation. However, you cannot use alias names
or alias ARNs in API operations that manage CMKs, such as DisableKey or
GetKeyPolicy. For information about the valid CMK identifiers for each
AWS KMS API operation, see the descriptions of the KeyId parameter in
the API operation documentation.

Because an alias is not a property of a CMK, you can delete and change the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases and alias ARNs of CMKs in each AWS account and Region, use the ListAliases operation.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the AWS Key Management Service Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation CreateAlias for usage and error information.

Returned Error Types:

* DependencyTimeoutException
The system timed out while trying to fulfill the request. The request can
be retried.

* AlreadyExistsException
The request was rejected because it attempted to create a resource that already
exists.

* NotFoundException
The request was rejected because the specified entity or resource could not
be found.

* InvalidAliasNameException
The request was rejected because the specified alias name is not valid.

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

* LimitExceededException
The request was rejected because a quota was exceeded. For more information,
see Quotas (https://docs.aws.amazon.com/kms/latest/developerguide/limits.html)
in the AWS Key Management Service Developer Guide.

* InvalidStateException
The request was rejected because the state of the specified resource is not
valid for this request.

For more information about how key state affects the use of a CMK, see How
Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html)
in the AWS Key Management Service Developer Guide .

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateAlias

Example (Shared00)

To create an alias The following example creates an alias for the specified customer master key (CMK).

Code:

svc := kms.New(session.New())
input := &kms.CreateAliasInput{
    AliasName:   aws.String("alias/ExampleAlias"),
    TargetKeyId: aws.String("1234abcd-12ab-34cd-56ef-1234567890ab"),
}

result, err := svc.CreateAlias(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case kms.ErrCodeDependencyTimeoutException:
            fmt.Println(kms.ErrCodeDependencyTimeoutException, aerr.Error())
        case kms.ErrCodeAlreadyExistsException:
            fmt.Println(kms.ErrCodeAlreadyExistsException, aerr.Error())
        case kms.ErrCodeNotFoundException:
            fmt.Println(kms.ErrCodeNotFoundException, aerr.Error())
        case kms.ErrCodeInvalidAliasNameException:
            fmt.Println(kms.ErrCodeInvalidAliasNameException, aerr.Error())
        case kms.ErrCodeInternalException:
            fmt.Println(kms.ErrCodeInternalException, aerr.Error())
        case kms.ErrCodeLimitExceededException:
            fmt.Println(kms.ErrCodeLimitExceededException, aerr.Error())
        case kms.ErrCodeInvalidStateException:
            fmt.Println(kms.ErrCodeInvalidStateException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*KMS) CreateAliasRequest

func (c *KMS) CreateAliasRequest(input *CreateAliasInput) (req *request.Request, output *CreateAliasOutput)

CreateAliasRequest generates a "aws/request.Request" representing the client's request for the CreateAlias operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateAlias for more information on using the CreateAlias API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateAliasRequest method.
req, resp := client.CreateAliasRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateAlias

func (*KMS) CreateAliasWithContext

func (c *KMS) CreateAliasWithContext(ctx aws.Context, input *CreateAliasInput, opts ...request.Option) (*CreateAliasOutput, error)

CreateAliasWithContext is the same as CreateAlias with the addition of the ability to pass a context and additional request options.

See CreateAlias for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) CreateCustomKeyStore

func (c *KMS) CreateCustomKeyStore(input *CreateCustomKeyStoreInput) (*CreateCustomKeyStoreOutput, error)

CreateCustomKeyStore API operation for AWS Key Management Service.

Creates a custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) that is associated with an AWS CloudHSM cluster (https://docs.aws.amazon.com/cloudhsm/latest/userguide/clusters.html) that you own and manage.

This operation is part of the Custom Key Store feature (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.

Before you create the custom key store, you must assemble the required elements, including an AWS CloudHSM cluster that fulfills the requirements for a custom key store. For details about the required elements, see Assemble the Prerequisites (https://docs.aws.amazon.com/kms/latest/developerguide/create-keystore.html#before-keystore) in the AWS Key Management Service Developer Guide.

When the operation completes successfully, it returns the ID of the new custom key store. Before you can use your new custom key store, you need to use the ConnectCustomKeyStore operation to connect the new key store to its AWS CloudHSM cluster. Even if you are not going to use your custom key store immediately, you might want to connect it to verify that all settings are correct and then disconnect it until you are ready to use it.

For help with failures, see Troubleshooting a Custom Key Store (https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html) in the AWS Key Management Service Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation CreateCustomKeyStore for usage and error information.

Returned Error Types:

* CloudHsmClusterInUseException
The request was rejected because the specified AWS CloudHSM cluster is already
associated with a custom key store or it shares a backup history with a cluster
that is associated with a custom key store. Each custom key store must be
associated with a different AWS CloudHSM cluster.

Clusters that share a backup history have the same cluster certificate. To
view the cluster certificate of a cluster, use the DescribeClusters (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html)
operation.

* CustomKeyStoreNameInUseException
The request was rejected because the specified custom key store name is already
assigned to another custom key store in the account. Try again with a custom
key store name that is unique in the account.

* CloudHsmClusterNotFoundException
The request was rejected because AWS KMS cannot find the AWS CloudHSM cluster
with the specified cluster ID. Retry the request with a different cluster
ID.

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

* CloudHsmClusterNotActiveException
The request was rejected because the AWS CloudHSM cluster that is associated
with the custom key store is not active. Initialize and activate the cluster
and try the command again. For detailed instructions, see Getting Started
(https://docs.aws.amazon.com/cloudhsm/latest/userguide/getting-started.html)
in the AWS CloudHSM User Guide.

* IncorrectTrustAnchorException
The request was rejected because the trust anchor certificate in the request
is not the trust anchor certificate for the specified AWS CloudHSM cluster.

When you initialize the cluster (https://docs.aws.amazon.com/cloudhsm/latest/userguide/initialize-cluster.html#sign-csr),
you create the trust anchor certificate and save it in the customerCA.crt
file.

* CloudHsmClusterInvalidConfigurationException
The request was rejected because the associated AWS CloudHSM cluster did
not meet the configuration requirements for a custom key store.

   * The cluster must be configured with private subnets in at least two
   different Availability Zones in the Region.

   * The security group for the cluster (https://docs.aws.amazon.com/cloudhsm/latest/userguide/configure-sg.html)
   (cloudhsm-cluster-<cluster-id>-sg) must include inbound rules and outbound
   rules that allow TCP traffic on ports 2223-2225. The Source in the inbound
   rules and the Destination in the outbound rules must match the security
   group ID. These rules are set by default when you create the cluster.
   Do not delete or change them. To get information about a particular security
   group, use the DescribeSecurityGroups (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSecurityGroups.html)
   operation.

   * The cluster must contain at least as many HSMs as the operation requires.
   To add HSMs, use the AWS CloudHSM CreateHsm (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_CreateHsm.html)
   operation. For the CreateCustomKeyStore, UpdateCustomKeyStore, and CreateKey
   operations, the AWS CloudHSM cluster must have at least two active HSMs,
   each in a different Availability Zone. For the ConnectCustomKeyStore operation,
   the AWS CloudHSM must contain at least one active HSM.

For information about the requirements for an AWS CloudHSM cluster that is
associated with a custom key store, see Assemble the Prerequisites (https://docs.aws.amazon.com/kms/latest/developerguide/create-keystore.html#before-keystore)
in the AWS Key Management Service Developer Guide. For information about
creating a private subnet for an AWS CloudHSM cluster, see Create a Private
Subnet (https://docs.aws.amazon.com/cloudhsm/latest/userguide/create-subnets.html)
in the AWS CloudHSM User Guide. For information about cluster security groups,
see Configure a Default Security Group (https://docs.aws.amazon.com/cloudhsm/latest/userguide/configure-sg.html)
in the AWS CloudHSM User Guide .

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateCustomKeyStore

func (*KMS) CreateCustomKeyStoreRequest

func (c *KMS) CreateCustomKeyStoreRequest(input *CreateCustomKeyStoreInput) (req *request.Request, output *CreateCustomKeyStoreOutput)

CreateCustomKeyStoreRequest generates a "aws/request.Request" representing the client's request for the CreateCustomKeyStore operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateCustomKeyStore for more information on using the CreateCustomKeyStore API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateCustomKeyStoreRequest method.
req, resp := client.CreateCustomKeyStoreRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateCustomKeyStore

func (*KMS) CreateCustomKeyStoreWithContext

func (c *KMS) CreateCustomKeyStoreWithContext(ctx aws.Context, input *CreateCustomKeyStoreInput, opts ...request.Option) (*CreateCustomKeyStoreOutput, error)

CreateCustomKeyStoreWithContext is the same as CreateCustomKeyStore with the addition of the ability to pass a context and additional request options.

See CreateCustomKeyStore for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) CreateGrant

func (c *KMS) CreateGrant(input *CreateGrantInput) (*CreateGrantOutput, error)

CreateGrant API operation for AWS Key Management Service.

Adds a grant to a customer master key (CMK). The grant allows the grantee principal to use the CMK when the conditions specified in the grant are met. When setting permissions, grants are an alternative to key policies.

To create a grant that allows a cryptographic operation (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) only when the request includes a particular encryption context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context), use the Constraints parameter. For details, see GrantConstraints.

You can create grants on symmetric and asymmetric CMKs. However, if the grant allows an operation that the CMK does not support, CreateGrant fails with a ValidationException.

* Grants for symmetric CMKs cannot allow operations that are not supported
for symmetric CMKs, including Sign, Verify, and GetPublicKey. (There are
limited exceptions to this rule for legacy operations, but you should
not create a grant for an operation that AWS KMS does not support.)

* Grants for asymmetric CMKs cannot allow operations that are not supported
for asymmetric CMKs, including operations that generate data keys (https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKey)
or data key pairs (https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKeyPair),
or operations related to automatic key rotation (https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html),
imported key material (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html),
or CMKs in custom key stores (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html).

* Grants for asymmetric CMKs with a KeyUsage of ENCRYPT_DECRYPT cannot
allow the Sign or Verify operations. Grants for asymmetric CMKs with a
KeyUsage of SIGN_VERIFY cannot allow the Encrypt or Decrypt operations.

* Grants for asymmetric CMKs cannot include an encryption context grant
constraint. An encryption context is not supported on asymmetric CMKs.

For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) in the AWS Key Management Service Developer Guide.

To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter. For more information about grants, see Grants (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html) in the AWS Key Management Service Developer Guide .

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the AWS Key Management Service Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation CreateGrant for usage and error information.

Returned Error Types:

* NotFoundException
The request was rejected because the specified entity or resource could not
be found.

* DisabledException
The request was rejected because the specified CMK is not enabled.

* DependencyTimeoutException
The system timed out while trying to fulfill the request. The request can
be retried.

* InvalidArnException
The request was rejected because a specified ARN, or an ARN in a key policy,
is not valid.

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

* InvalidGrantTokenException
The request was rejected because the specified grant token is not valid.

* LimitExceededException
The request was rejected because a quota was exceeded. For more information,
see Quotas (https://docs.aws.amazon.com/kms/latest/developerguide/limits.html)
in the AWS Key Management Service Developer Guide.

* InvalidStateException
The request was rejected because the state of the specified resource is not
valid for this request.

For more information about how key state affects the use of a CMK, see How
Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html)
in the AWS Key Management Service Developer Guide .

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateGrant

Example (Shared00)

To create a grant The following example creates a grant that allows the specified IAM role to encrypt data with the specified customer master key (CMK).

Code:

svc := kms.New(session.New())
input := &kms.CreateGrantInput{
    GranteePrincipal: aws.String("arn:aws:iam::111122223333:role/ExampleRole"),
    KeyId:            aws.String("arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab"),
    Operations: []*string{
        aws.String("Encrypt"),
        aws.String("Decrypt"),
    },
}

result, err := svc.CreateGrant(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case kms.ErrCodeNotFoundException:
            fmt.Println(kms.ErrCodeNotFoundException, aerr.Error())
        case kms.ErrCodeDisabledException:
            fmt.Println(kms.ErrCodeDisabledException, aerr.Error())
        case kms.ErrCodeDependencyTimeoutException:
            fmt.Println(kms.ErrCodeDependencyTimeoutException, aerr.Error())
        case kms.ErrCodeInvalidArnException:
            fmt.Println(kms.ErrCodeInvalidArnException, aerr.Error())
        case kms.ErrCodeInternalException:
            fmt.Println(kms.ErrCodeInternalException, aerr.Error())
        case kms.ErrCodeInvalidGrantTokenException:
            fmt.Println(kms.ErrCodeInvalidGrantTokenException, aerr.Error())
        case kms.ErrCodeLimitExceededException:
            fmt.Println(kms.ErrCodeLimitExceededException, aerr.Error())
        case kms.ErrCodeInvalidStateException:
            fmt.Println(kms.ErrCodeInvalidStateException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*KMS) CreateGrantRequest

func (c *KMS) CreateGrantRequest(input *CreateGrantInput) (req *request.Request, output *CreateGrantOutput)

CreateGrantRequest generates a "aws/request.Request" representing the client's request for the CreateGrant operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateGrant for more information on using the CreateGrant API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateGrantRequest method.
req, resp := client.CreateGrantRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateGrant

func (*KMS) CreateGrantWithContext

func (c *KMS) CreateGrantWithContext(ctx aws.Context, input *CreateGrantInput, opts ...request.Option) (*CreateGrantOutput, error)

CreateGrantWithContext is the same as CreateGrant with the addition of the ability to pass a context and additional request options.

See CreateGrant for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) CreateKey

func (c *KMS) CreateKey(input *CreateKeyInput) (*CreateKeyOutput, error)

CreateKey API operation for AWS Key Management Service.

Creates a unique customer managed customer master key (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master-keys) (CMK) in your AWS account and Region. You cannot use this operation to create a CMK in a different AWS account.

You can use the CreateKey operation to create symmetric or asymmetric CMKs.

* Symmetric CMKs contain a 256-bit symmetric key that never leaves AWS
KMS unencrypted. To use the CMK, you must call AWS KMS. You can use a
symmetric CMK to encrypt and decrypt small amounts of data, but they are
typically used to generate data keys (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys)
and data keys pairs (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-key-pairs).
For details, see GenerateDataKey and GenerateDataKeyPair.

* Asymmetric CMKs can contain an RSA key pair or an Elliptic Curve (ECC)
key pair. The private key in an asymmetric CMK never leaves AWS KMS unencrypted.
However, you can use the GetPublicKey operation to download the public
key so it can be used outside of AWS KMS. CMKs with RSA key pairs can
be used to encrypt or decrypt data or sign and verify messages (but not
both). CMKs with ECC key pairs can be used only to sign and verify messages.

For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) in the AWS Key Management Service Developer Guide.

To create different types of CMKs, use the following guidance:

Asymmetric CMKs

To create an asymmetric CMK, use the CustomerMasterKeySpec parameter to specify the type of key material in the CMK. Then, use the KeyUsage parameter to determine whether the CMK will be used to encrypt and decrypt or sign and verify. You can't change these properties after the CMK is created.

Symmetric CMKs

When creating a symmetric CMK, you don't need to specify the CustomerMasterKeySpec or KeyUsage parameters. The default value for CustomerMasterKeySpec, SYMMETRIC_DEFAULT, and the default value for KeyUsage, ENCRYPT_DECRYPT, are the only valid values for symmetric CMKs.

Imported Key Material

To import your own key material, begin by creating a symmetric CMK with no key material. To do this, use the Origin parameter of CreateKey with a value of EXTERNAL. Next, use GetParametersForImport operation to get a public key and import token, and use the public key to encrypt your key material. Then, use ImportKeyMaterial with your import token to import the key material. For step-by-step instructions, see Importing Key Material (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) in the AWS Key Management Service Developer Guide . You cannot import the key material into an asymmetric CMK.

Custom Key Stores

To create a symmetric CMK in a custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html), use the CustomKeyStoreId parameter to specify the custom key store. You must also use the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs in different Availability Zones in the AWS Region.

You cannot create an asymmetric CMK in a custom key store. For information about custom key stores in AWS KMS see Using Custom Key Stores (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) in the AWS Key Management Service Developer Guide .

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation CreateKey for usage and error information.

Returned Error Types:

* MalformedPolicyDocumentException
The request was rejected because the specified policy is not syntactically
or semantically correct.

* DependencyTimeoutException
The system timed out while trying to fulfill the request. The request can
be retried.

* InvalidArnException
The request was rejected because a specified ARN, or an ARN in a key policy,
is not valid.

* UnsupportedOperationException
The request was rejected because a specified parameter is not supported or
a specified resource is not valid for this operation.

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

* LimitExceededException
The request was rejected because a quota was exceeded. For more information,
see Quotas (https://docs.aws.amazon.com/kms/latest/developerguide/limits.html)
in the AWS Key Management Service Developer Guide.

* TagException
The request was rejected because one or more tags are not valid.

* CustomKeyStoreNotFoundException
The request was rejected because AWS KMS cannot find a custom key store with
the specified key store name or ID.

* CustomKeyStoreInvalidStateException
The request was rejected because of the ConnectionState of the custom key
store. To get the ConnectionState of a custom key store, use the DescribeCustomKeyStores
operation.

This exception is thrown under the following conditions:

   * You requested the CreateKey or GenerateRandom operation in a custom
   key store that is not connected. These operations are valid only when
   the custom key store ConnectionState is CONNECTED.

   * You requested the UpdateCustomKeyStore or DeleteCustomKeyStore operation
   on a custom key store that is not disconnected. This operation is valid
   only when the custom key store ConnectionState is DISCONNECTED.

   * You requested the ConnectCustomKeyStore operation on a custom key store
   with a ConnectionState of DISCONNECTING or FAILED. This operation is valid
   for all other ConnectionState values.

* CloudHsmClusterInvalidConfigurationException
The request was rejected because the associated AWS CloudHSM cluster did
not meet the configuration requirements for a custom key store.

   * The cluster must be configured with private subnets in at least two
   different Availability Zones in the Region.

   * The security group for the cluster (https://docs.aws.amazon.com/cloudhsm/latest/userguide/configure-sg.html)
   (cloudhsm-cluster-<cluster-id>-sg) must include inbound rules and outbound
   rules that allow TCP traffic on ports 2223-2225. The Source in the inbound
   rules and the Destination in the outbound rules must match the security
   group ID. These rules are set by default when you create the cluster.
   Do not delete or change them. To get information about a particular security
   group, use the DescribeSecurityGroups (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSecurityGroups.html)
   operation.

   * The cluster must contain at least as many HSMs as the operation requires.
   To add HSMs, use the AWS CloudHSM CreateHsm (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_CreateHsm.html)
   operation. For the CreateCustomKeyStore, UpdateCustomKeyStore, and CreateKey
   operations, the AWS CloudHSM cluster must have at least two active HSMs,
   each in a different Availability Zone. For the ConnectCustomKeyStore operation,
   the AWS CloudHSM must contain at least one active HSM.

For information about the requirements for an AWS CloudHSM cluster that is
associated with a custom key store, see Assemble the Prerequisites (https://docs.aws.amazon.com/kms/latest/developerguide/create-keystore.html#before-keystore)
in the AWS Key Management Service Developer Guide. For information about
creating a private subnet for an AWS CloudHSM cluster, see Create a Private
Subnet (https://docs.aws.amazon.com/cloudhsm/latest/userguide/create-subnets.html)
in the AWS CloudHSM User Guide. For information about cluster security groups,
see Configure a Default Security Group (https://docs.aws.amazon.com/cloudhsm/latest/userguide/configure-sg.html)
in the AWS CloudHSM User Guide .

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateKey

Example (Shared00)

To create a customer master key (CMK) The following example creates a CMK.

Code:

svc := kms.New(session.New())
input := &kms.CreateKeyInput{
    Tags: []*kms.Tag{
        {
            TagKey:   aws.String("CreatedBy"),
            TagValue: aws.String("ExampleUser"),
        },
    },
}

result, err := svc.CreateKey(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case kms.ErrCodeMalformedPolicyDocumentException:
            fmt.Println(kms.ErrCodeMalformedPolicyDocumentException, aerr.Error())
        case kms.ErrCodeDependencyTimeoutException:
            fmt.Println(kms.ErrCodeDependencyTimeoutException, aerr.Error())
        case kms.ErrCodeInvalidArnException:
            fmt.Println(kms.ErrCodeInvalidArnException, aerr.Error())
        case kms.ErrCodeUnsupportedOperationException:
            fmt.Println(kms.ErrCodeUnsupportedOperationException, aerr.Error())
        case kms.ErrCodeInternalException:
            fmt.Println(kms.ErrCodeInternalException, aerr.Error())
        case kms.ErrCodeLimitExceededException:
            fmt.Println(kms.ErrCodeLimitExceededException, aerr.Error())
        case kms.ErrCodeTagException:
            fmt.Println(kms.ErrCodeTagException, aerr.Error())
        case kms.ErrCodeCustomKeyStoreNotFoundException:
            fmt.Println(kms.ErrCodeCustomKeyStoreNotFoundException, aerr.Error())
        case kms.ErrCodeCustomKeyStoreInvalidStateException:
            fmt.Println(kms.ErrCodeCustomKeyStoreInvalidStateException, aerr.Error())
        case kms.ErrCodeCloudHsmClusterInvalidConfigurationException:
            fmt.Println(kms.ErrCodeCloudHsmClusterInvalidConfigurationException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*KMS) CreateKeyRequest

func (c *KMS) CreateKeyRequest(input *CreateKeyInput) (req *request.Request, output *CreateKeyOutput)

CreateKeyRequest generates a "aws/request.Request" representing the client's request for the CreateKey operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateKey for more information on using the CreateKey API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateKeyRequest method.
req, resp := client.CreateKeyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/CreateKey

func (*KMS) CreateKeyWithContext

func (c *KMS) CreateKeyWithContext(ctx aws.Context, input *CreateKeyInput, opts ...request.Option) (*CreateKeyOutput, error)

CreateKeyWithContext is the same as CreateKey with the addition of the ability to pass a context and additional request options.

See CreateKey for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) Decrypt

func (c *KMS) Decrypt(input *DecryptInput) (*DecryptOutput, error)

Decrypt API operation for AWS Key Management Service.

Decrypts ciphertext that was encrypted by a AWS KMS customer master key (CMK) using any of the following operations:

* Encrypt

* GenerateDataKey

* GenerateDataKeyPair

* GenerateDataKeyWithoutPlaintext

* GenerateDataKeyPairWithoutPlaintext

You can use this operation to decrypt ciphertext that was encrypted under a symmetric or asymmetric CMK. When the CMK is asymmetric, you must specify the CMK and the encryption algorithm that was used to encrypt the ciphertext. For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) in the AWS Key Management Service Developer Guide.

The Decrypt operation also decrypts ciphertext that was encrypted outside of AWS KMS by the public key in an AWS KMS asymmetric CMK. However, it cannot decrypt ciphertext produced by other libraries, such as the AWS Encryption SDK (https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/) or Amazon S3 client-side encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html). These libraries return a ciphertext format that is incompatible with AWS KMS.

If the ciphertext was encrypted under a symmetric CMK, you do not need to specify the CMK or the encryption algorithm. AWS KMS can get this information from metadata that it adds to the symmetric ciphertext blob. However, if you prefer, you can specify the KeyId to ensure that a particular CMK is used to decrypt the ciphertext. If you specify a different CMK than the one used to encrypt the ciphertext, the Decrypt operation fails.

Whenever possible, use key policies to give users permission to call the Decrypt operation on a particular CMK, instead of using IAM policies. Otherwise, you might create an IAM user policy that gives the user Decrypt permission on all CMKs. This user could decrypt ciphertext that was encrypted by CMKs in other accounts if the key policy for the cross-account CMK permits it. If you must use an IAM policy for Decrypt permissions, limit the user to particular CMKs or particular trusted accounts.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the AWS Key Management Service Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation Decrypt for usage and error information.

Returned Error Types:

* NotFoundException
The request was rejected because the specified entity or resource could not
be found.

* DisabledException
The request was rejected because the specified CMK is not enabled.

* InvalidCiphertextException
From the Decrypt or ReEncrypt operation, the request was rejected because
the specified ciphertext, or additional authenticated data incorporated into
the ciphertext, such as the encryption context, is corrupted, missing, or
otherwise invalid.

From the ImportKeyMaterial operation, the request was rejected because AWS
KMS could not decrypt the encrypted (wrapped) key material.

* KeyUnavailableException
The request was rejected because the specified CMK was not available. You
can retry the request.

* IncorrectKeyException
The request was rejected because the specified CMK cannot decrypt the data.
The KeyId in a Decrypt request and the SourceKeyId in a ReEncrypt request
must identify the same CMK that was used to encrypt the ciphertext.

* InvalidKeyUsageException
The request was rejected for one of the following reasons:

   * The KeyUsage value of the CMK 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 CMK (CustomerMasterKeySpec).

For encrypting, decrypting, re-encrypting, and generating data keys, the
KeyUsage must be ENCRYPT_DECRYPT. For signing and verifying, the KeyUsage
must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation.

To find the encryption or signing algorithms supported for a particular CMK,
use the DescribeKey operation.

* DependencyTimeoutException
The system timed out while trying to fulfill the request. The request can
be retried.

* InvalidGrantTokenException
The request was rejected because the specified grant token is not valid.

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

* InvalidStateException
The request was rejected because the state of the specified resource is not
valid for this request.

For more information about how key state affects the use of a CMK, see How
Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html)
in the AWS Key Management Service Developer Guide .

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/Decrypt

Example (Shared00)

To decrypt data The following example decrypts data that was encrypted with a customer master key (CMK) in AWS KMS.

Code:

svc := kms.New(session.New())
input := &kms.DecryptInput{
    CiphertextBlob: []byte("<binary data>"),
}

result, err := svc.Decrypt(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case kms.ErrCodeNotFoundException:
            fmt.Println(kms.ErrCodeNotFoundException, aerr.Error())
        case kms.ErrCodeDisabledException:
            fmt.Println(kms.ErrCodeDisabledException, aerr.Error())
        case kms.ErrCodeInvalidCiphertextException:
            fmt.Println(kms.ErrCodeInvalidCiphertextException, aerr.Error())
        case kms.ErrCodeKeyUnavailableException:
            fmt.Println(kms.ErrCodeKeyUnavailableException, aerr.Error())
        case kms.ErrCodeIncorrectKeyException:
            fmt.Println(kms.ErrCodeIncorrectKeyException, aerr.Error())
        case kms.ErrCodeInvalidKeyUsageException:
            fmt.Println(kms.ErrCodeInvalidKeyUsageException, aerr.Error())
        case kms.ErrCodeDependencyTimeoutException:
            fmt.Println(kms.ErrCodeDependencyTimeoutException, aerr.Error())
        case kms.ErrCodeInvalidGrantTokenException:
            fmt.Println(kms.ErrCodeInvalidGrantTokenException, aerr.Error())
        case kms.ErrCodeInternalException:
            fmt.Println(kms.ErrCodeInternalException, aerr.Error())
        case kms.ErrCodeInvalidStateException:
            fmt.Println(kms.ErrCodeInvalidStateException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*KMS) DecryptRequest

func (c *KMS) DecryptRequest(input *DecryptInput) (req *request.Request, output *DecryptOutput)

DecryptRequest generates a "aws/request.Request" representing the client's request for the Decrypt operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See Decrypt for more information on using the Decrypt API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DecryptRequest method.
req, resp := client.DecryptRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/Decrypt

func (*KMS) DecryptWithContext

func (c *KMS) DecryptWithContext(ctx aws.Context, input *DecryptInput, opts ...request.Option) (*DecryptOutput, error)

DecryptWithContext is the same as Decrypt with the addition of the ability to pass a context and additional request options.

See Decrypt for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) DeleteAlias

func (c *KMS) DeleteAlias(input *DeleteAliasInput) (*DeleteAliasOutput, error)

DeleteAlias API operation for AWS Key Management Service.

Deletes the specified alias. You cannot perform this operation on an alias in a different AWS account.

Because an alias is not a property of a CMK, you can delete and change the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs, use the ListAliases operation.

Each CMK can have multiple aliases. To change the alias of a CMK, use DeleteAlias to delete the current alias and CreateAlias to create a new alias. To associate an existing alias with a different customer master key (CMK), call UpdateAlias.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation DeleteAlias for usage and error information.

Returned Error Types:

* DependencyTimeoutException
The system timed out while trying to fulfill the request. The request can
be retried.

* NotFoundException
The request was rejected because the specified entity or resource could not
be found.

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

* InvalidStateException
The request was rejected because the state of the specified resource is not
valid for this request.

For more information about how key state affects the use of a CMK, see How
Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html)
in the AWS Key Management Service Developer Guide .

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DeleteAlias

Example (Shared00)

To delete an alias The following example deletes the specified alias.

Code:

svc := kms.New(session.New())
input := &kms.DeleteAliasInput{
    AliasName: aws.String("alias/ExampleAlias"),
}

result, err := svc.DeleteAlias(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case kms.ErrCodeDependencyTimeoutException:
            fmt.Println(kms.ErrCodeDependencyTimeoutException, aerr.Error())
        case kms.ErrCodeNotFoundException:
            fmt.Println(kms.ErrCodeNotFoundException, aerr.Error())
        case kms.ErrCodeInternalException:
            fmt.Println(kms.ErrCodeInternalException, aerr.Error())
        case kms.ErrCodeInvalidStateException:
            fmt.Println(kms.ErrCodeInvalidStateException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*KMS) DeleteAliasRequest

func (c *KMS) DeleteAliasRequest(input *DeleteAliasInput) (req *request.Request, output *DeleteAliasOutput)

DeleteAliasRequest generates a "aws/request.Request" representing the client's request for the DeleteAlias operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteAlias for more information on using the DeleteAlias API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteAliasRequest method.
req, resp := client.DeleteAliasRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DeleteAlias

func (*KMS) DeleteAliasWithContext

func (c *KMS) DeleteAliasWithContext(ctx aws.Context, input *DeleteAliasInput, opts ...request.Option) (*DeleteAliasOutput, error)

DeleteAliasWithContext is the same as DeleteAlias with the addition of the ability to pass a context and additional request options.

See DeleteAlias for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) DeleteCustomKeyStore

func (c *KMS) DeleteCustomKeyStore(input *DeleteCustomKeyStoreInput) (*DeleteCustomKeyStoreOutput, error)

DeleteCustomKeyStore API operation for AWS Key Management Service.

Deletes a custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html). This operation does not delete the AWS CloudHSM cluster that is associated with the custom key store, or affect any users or keys in the cluster.

The custom key store that you delete cannot contain any AWS KMS customer master keys (CMKs) (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys). Before deleting the key store, verify that you will never need to use any of the CMKs in the key store for any cryptographic operations (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations). Then, use ScheduleKeyDeletion to delete the AWS KMS customer master keys (CMKs) from the key store. When the scheduled waiting period expires, the ScheduleKeyDeletion operation deletes the CMKs. Then it makes a best effort to delete the key material from the associated cluster. However, you might need to manually delete the orphaned key material (https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-orphaned-key) from the cluster and its backups.

After all CMKs are deleted from AWS KMS, use DisconnectCustomKeyStore to disconnect the key store from AWS KMS. Then, you can delete the custom key store.

Instead of deleting the custom key store, consider using DisconnectCustomKeyStore to disconnect it from AWS KMS. While the key store is disconnected, you cannot create or use the CMKs in the key store. But, you do not need to delete CMKs and you can reconnect a disconnected custom key store at any time.

If the operation succeeds, it returns a JSON object with no properties.

This operation is part of the Custom Key Store feature (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation DeleteCustomKeyStore for usage and error information.

Returned Error Types:

* CustomKeyStoreHasCMKsException
The request was rejected because the custom key store contains AWS KMS customer
master keys (CMKs). After verifying that you do not need to use the CMKs,
use the ScheduleKeyDeletion operation to delete the CMKs. After they are
deleted, you can delete the custom key store.

* CustomKeyStoreInvalidStateException
The request was rejected because of the ConnectionState of the custom key
store. To get the ConnectionState of a custom key store, use the DescribeCustomKeyStores
operation.

This exception is thrown under the following conditions:

   * You requested the CreateKey or GenerateRandom operation in a custom
   key store that is not connected. These operations are valid only when
   the custom key store ConnectionState is CONNECTED.

   * You requested the UpdateCustomKeyStore or DeleteCustomKeyStore operation
   on a custom key store that is not disconnected. This operation is valid
   only when the custom key store ConnectionState is DISCONNECTED.

   * You requested the ConnectCustomKeyStore operation on a custom key store
   with a ConnectionState of DISCONNECTING or FAILED. This operation is valid
   for all other ConnectionState values.

* CustomKeyStoreNotFoundException
The request was rejected because AWS KMS cannot find a custom key store with
the specified key store name or ID.

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DeleteCustomKeyStore

func (*KMS) DeleteCustomKeyStoreRequest

func (c *KMS) DeleteCustomKeyStoreRequest(input *DeleteCustomKeyStoreInput) (req *request.Request, output *DeleteCustomKeyStoreOutput)

DeleteCustomKeyStoreRequest generates a "aws/request.Request" representing the client's request for the DeleteCustomKeyStore operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteCustomKeyStore for more information on using the DeleteCustomKeyStore API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteCustomKeyStoreRequest method.
req, resp := client.DeleteCustomKeyStoreRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DeleteCustomKeyStore

func (*KMS) DeleteCustomKeyStoreWithContext

func (c *KMS) DeleteCustomKeyStoreWithContext(ctx aws.Context, input *DeleteCustomKeyStoreInput, opts ...request.Option) (*DeleteCustomKeyStoreOutput, error)

DeleteCustomKeyStoreWithContext is the same as DeleteCustomKeyStore with the addition of the ability to pass a context and additional request options.

See DeleteCustomKeyStore for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) DeleteImportedKeyMaterial

func (c *KMS) DeleteImportedKeyMaterial(input *DeleteImportedKeyMaterialInput) (*DeleteImportedKeyMaterialOutput, error)

DeleteImportedKeyMaterial API operation for AWS Key Management Service.

Deletes key material that you previously imported. This operation makes the specified customer master key (CMK) unusable. For more information about importing key material into AWS KMS, see Importing Key Material (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) in the AWS Key Management Service Developer Guide. You cannot perform this operation on a CMK in a different AWS account.

When the specified CMK is in the PendingDeletion state, this operation does not change the CMK's state. Otherwise, it changes the CMK's state to PendingImport.

After you delete key material, you can use ImportKeyMaterial to reimport the same key material into the CMK.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the AWS Key Management Service Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation DeleteImportedKeyMaterial for usage and error information.

Returned Error Types:

* InvalidArnException
The request was rejected because a specified ARN, or an ARN in a key policy,
is not valid.

* UnsupportedOperationException
The request was rejected because a specified parameter is not supported or
a specified resource is not valid for this operation.

* DependencyTimeoutException
The system timed out while trying to fulfill the request. The request can
be retried.

* NotFoundException
The request was rejected because the specified entity or resource could not
be found.

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

* InvalidStateException
The request was rejected because the state of the specified resource is not
valid for this request.

For more information about how key state affects the use of a CMK, see How
Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html)
in the AWS Key Management Service Developer Guide .

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DeleteImportedKeyMaterial

Example (Shared00)

To delete imported key material The following example deletes the imported key material from the specified customer master key (CMK).

Code:

svc := kms.New(session.New())
input := &kms.DeleteImportedKeyMaterialInput{
    KeyId: aws.String("1234abcd-12ab-34cd-56ef-1234567890ab"),
}

result, err := svc.DeleteImportedKeyMaterial(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case kms.ErrCodeInvalidArnException:
            fmt.Println(kms.ErrCodeInvalidArnException, aerr.Error())
        case kms.ErrCodeUnsupportedOperationException:
            fmt.Println(kms.ErrCodeUnsupportedOperationException, aerr.Error())
        case kms.ErrCodeDependencyTimeoutException:
            fmt.Println(kms.ErrCodeDependencyTimeoutException, aerr.Error())
        case kms.ErrCodeNotFoundException:
            fmt.Println(kms.ErrCodeNotFoundException, aerr.Error())
        case kms.ErrCodeInternalException:
            fmt.Println(kms.ErrCodeInternalException, aerr.Error())
        case kms.ErrCodeInvalidStateException:
            fmt.Println(kms.ErrCodeInvalidStateException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*KMS) DeleteImportedKeyMaterialRequest

func (c *KMS) DeleteImportedKeyMaterialRequest(input *DeleteImportedKeyMaterialInput) (req *request.Request, output *DeleteImportedKeyMaterialOutput)

DeleteImportedKeyMaterialRequest generates a "aws/request.Request" representing the client's request for the DeleteImportedKeyMaterial operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteImportedKeyMaterial for more information on using the DeleteImportedKeyMaterial API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteImportedKeyMaterialRequest method.
req, resp := client.DeleteImportedKeyMaterialRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DeleteImportedKeyMaterial

func (*KMS) DeleteImportedKeyMaterialWithContext

func (c *KMS) DeleteImportedKeyMaterialWithContext(ctx aws.Context, input *DeleteImportedKeyMaterialInput, opts ...request.Option) (*DeleteImportedKeyMaterialOutput, error)

DeleteImportedKeyMaterialWithContext is the same as DeleteImportedKeyMaterial with the addition of the ability to pass a context and additional request options.

See DeleteImportedKeyMaterial for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) DescribeCustomKeyStores

func (c *KMS) DescribeCustomKeyStores(input *DescribeCustomKeyStoresInput) (*DescribeCustomKeyStoresOutput, error)

DescribeCustomKeyStores API operation for AWS Key Management Service.

Gets information about custom key stores (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) in the account and region.

This operation is part of the Custom Key Store feature (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.

By default, this operation returns information about all custom key stores in the account and region. To get only information about a particular custom key store, use either the CustomKeyStoreName or CustomKeyStoreId parameter (but not both).

To determine whether the custom key store is connected to its AWS CloudHSM cluster, use the ConnectionState element in the response. If an attempt to connect the custom key store failed, the ConnectionState value is FAILED and the ConnectionErrorCode element in the response indicates the cause of the failure. For help interpreting the ConnectionErrorCode, see CustomKeyStoresListEntry.

Custom key stores have a DISCONNECTED connection state if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If your custom key store state is CONNECTED but you are having trouble using it, make sure that its associated AWS CloudHSM cluster is active and contains the minimum number of HSMs required for the operation, if any.

For help repairing your custom key store, see the Troubleshooting Custom Key Stores (https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html) topic in the AWS Key Management Service Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation DescribeCustomKeyStores for usage and error information.

Returned Error Types:

* CustomKeyStoreNotFoundException
The request was rejected because AWS KMS cannot find a custom key store with
the specified key store name or ID.

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DescribeCustomKeyStores

func (*KMS) DescribeCustomKeyStoresRequest

func (c *KMS) DescribeCustomKeyStoresRequest(input *DescribeCustomKeyStoresInput) (req *request.Request, output *DescribeCustomKeyStoresOutput)

DescribeCustomKeyStoresRequest generates a "aws/request.Request" representing the client's request for the DescribeCustomKeyStores operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeCustomKeyStores for more information on using the DescribeCustomKeyStores API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeCustomKeyStoresRequest method.
req, resp := client.DescribeCustomKeyStoresRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DescribeCustomKeyStores

func (*KMS) DescribeCustomKeyStoresWithContext

func (c *KMS) DescribeCustomKeyStoresWithContext(ctx aws.Context, input *DescribeCustomKeyStoresInput, opts ...request.Option) (*DescribeCustomKeyStoresOutput, error)

DescribeCustomKeyStoresWithContext is the same as DescribeCustomKeyStores with the addition of the ability to pass a context and additional request options.

See DescribeCustomKeyStores for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) DescribeKey

func (c *KMS) DescribeKey(input *DescribeKeyInput) (*DescribeKeyOutput, error)

DescribeKey API operation for AWS Key Management Service.

Provides detailed information about a customer master key (CMK). You can run DescribeKey on a customer managed CMK (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk) or an AWS managed CMK (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk).

This detailed information includes the key ARN, creation date (and deletion date, if applicable), the key state, and the origin and expiration date (if any) of the key material. For CMKs in custom key stores, it includes information about the custom key store, such as the key store ID and the AWS CloudHSM cluster ID. It includes fields, like KeySpec, that help you distinguish symmetric from asymmetric CMKs. It also provides information that is particularly important to asymmetric CMKs, such as the key usage (encryption or signing) and the encryption algorithms or signing algorithms that the CMK supports.

DescribeKey does not return the following information:

* Aliases associated with the CMK. To get this information, use ListAliases.

* Whether automatic key rotation is enabled on the CMK. To get this information,
use GetKeyRotationStatus. Also, some key states prevent a CMK from being
automatically rotated. For details, see How Automatic Key Rotation Works
(https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotate-keys-how-it-works)
in AWS Key Management Service Developer Guide.

* Tags on the CMK. To get this information, use ListResourceTags.

* Key policies and grants on the CMK. To get this information, use GetKeyPolicy
and ListGrants.

If you call the DescribeKey operation on a predefined AWS alias, that is, an AWS alias with no key ID, AWS KMS creates an AWS managed CMK (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys). Then, it associates the alias with the new CMK, and returns the KeyId and Arn of the new CMK in the response.

To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation DescribeKey for usage and error information.

Returned Error Types:

* NotFoundException
The request was rejected because the specified entity or resource could not
be found.

* InvalidArnException
The request was rejected because a specified ARN, or an ARN in a key policy,
is not valid.

* DependencyTimeoutException
The system timed out while trying to fulfill the request. The request can
be retried.

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DescribeKey

Example (Shared00)

To obtain information about a customer master key (CMK) The following example returns information (metadata) about the specified CMK.

Code:

svc := kms.New(session.New())
input := &kms.DescribeKeyInput{
    KeyId: aws.String("1234abcd-12ab-34cd-56ef-1234567890ab"),
}

result, err := svc.DescribeKey(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case kms.ErrCodeNotFoundException:
            fmt.Println(kms.ErrCodeNotFoundException, aerr.Error())
        case kms.ErrCodeInvalidArnException:
            fmt.Println(kms.ErrCodeInvalidArnException, aerr.Error())
        case kms.ErrCodeDependencyTimeoutException:
            fmt.Println(kms.ErrCodeDependencyTimeoutException, aerr.Error())
        case kms.ErrCodeInternalException:
            fmt.Println(kms.ErrCodeInternalException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*KMS) DescribeKeyRequest

func (c *KMS) DescribeKeyRequest(input *DescribeKeyInput) (req *request.Request, output *DescribeKeyOutput)

DescribeKeyRequest generates a "aws/request.Request" representing the client's request for the DescribeKey operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeKey for more information on using the DescribeKey API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeKeyRequest method.
req, resp := client.DescribeKeyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DescribeKey

func (*KMS) DescribeKeyWithContext

func (c *KMS) DescribeKeyWithContext(ctx aws.Context, input *DescribeKeyInput, opts ...request.Option) (*DescribeKeyOutput, error)

DescribeKeyWithContext is the same as DescribeKey with the addition of the ability to pass a context and additional request options.

See DescribeKey for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) DisableKey

func (c *KMS) DisableKey(input *DisableKeyInput) (*DisableKeyOutput, error)

DisableKey API operation for AWS Key Management Service.

Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic operations (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations). You cannot perform this operation on a CMK in a different AWS account.

For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the AWS Key Management Service Developer Guide .

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the AWS Key Management Service Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation DisableKey for usage and error information.

Returned Error Types:

* NotFoundException
The request was rejected because the specified entity or resource could not
be found.

* InvalidArnException
The request was rejected because a specified ARN, or an ARN in a key policy,
is not valid.

* DependencyTimeoutException
The system timed out while trying to fulfill the request. The request can
be retried.

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

* InvalidStateException
The request was rejected because the state of the specified resource is not
valid for this request.

For more information about how key state affects the use of a CMK, see How
Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html)
in the AWS Key Management Service Developer Guide .

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DisableKey

Example (Shared00)

To disable a customer master key (CMK) The following example disables the specified CMK.

Code:

svc := kms.New(session.New())
input := &kms.DisableKeyInput{
    KeyId: aws.String("1234abcd-12ab-34cd-56ef-1234567890ab"),
}

result, err := svc.DisableKey(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case kms.ErrCodeNotFoundException:
            fmt.Println(kms.ErrCodeNotFoundException, aerr.Error())
        case kms.ErrCodeInvalidArnException:
            fmt.Println(kms.ErrCodeInvalidArnException, aerr.Error())
        case kms.ErrCodeDependencyTimeoutException:
            fmt.Println(kms.ErrCodeDependencyTimeoutException, aerr.Error())
        case kms.ErrCodeInternalException:
            fmt.Println(kms.ErrCodeInternalException, aerr.Error())
        case kms.ErrCodeInvalidStateException:
            fmt.Println(kms.ErrCodeInvalidStateException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*KMS) DisableKeyRequest

func (c *KMS) DisableKeyRequest(input *DisableKeyInput) (req *request.Request, output *DisableKeyOutput)

DisableKeyRequest generates a "aws/request.Request" representing the client's request for the DisableKey operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisableKey for more information on using the DisableKey API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DisableKeyRequest method.
req, resp := client.DisableKeyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DisableKey

func (*KMS) DisableKeyRotation

func (c *KMS) DisableKeyRotation(input *DisableKeyRotationInput) (*DisableKeyRotationOutput, error)

DisableKeyRotation API operation for AWS Key Management Service.

Disables automatic rotation of the key material (https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) for the specified symmetric customer master key (CMK).

You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html). You cannot perform this operation on a CMK in a different AWS account.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the AWS Key Management Service Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation DisableKeyRotation for usage and error information.

Returned Error Types:

* NotFoundException
The request was rejected because the specified entity or resource could not
be found.

* DisabledException
The request was rejected because the specified CMK is not enabled.

* InvalidArnException
The request was rejected because a specified ARN, or an ARN in a key policy,
is not valid.

* DependencyTimeoutException
The system timed out while trying to fulfill the request. The request can
be retried.

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

* InvalidStateException
The request was rejected because the state of the specified resource is not
valid for this request.

For more information about how key state affects the use of a CMK, see How
Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html)
in the AWS Key Management Service Developer Guide .

* UnsupportedOperationException
The request was rejected because a specified parameter is not supported or
a specified resource is not valid for this operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DisableKeyRotation

Example (Shared00)

To disable automatic rotation of key material The following example disables automatic annual rotation of the key material for the specified CMK.

Code:

svc := kms.New(session.New())
input := &kms.DisableKeyRotationInput{
    KeyId: aws.String("1234abcd-12ab-34cd-56ef-1234567890ab"),
}

result, err := svc.DisableKeyRotation(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case kms.ErrCodeNotFoundException:
            fmt.Println(kms.ErrCodeNotFoundException, aerr.Error())
        case kms.ErrCodeDisabledException:
            fmt.Println(kms.ErrCodeDisabledException, aerr.Error())
        case kms.ErrCodeInvalidArnException:
            fmt.Println(kms.ErrCodeInvalidArnException, aerr.Error())
        case kms.ErrCodeDependencyTimeoutException:
            fmt.Println(kms.ErrCodeDependencyTimeoutException, aerr.Error())
        case kms.ErrCodeInternalException:
            fmt.Println(kms.ErrCodeInternalException, aerr.Error())
        case kms.ErrCodeInvalidStateException:
            fmt.Println(kms.ErrCodeInvalidStateException, aerr.Error())
        case kms.ErrCodeUnsupportedOperationException:
            fmt.Println(kms.ErrCodeUnsupportedOperationException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*KMS) DisableKeyRotationRequest

func (c *KMS) DisableKeyRotationRequest(input *DisableKeyRotationInput) (req *request.Request, output *DisableKeyRotationOutput)

DisableKeyRotationRequest generates a "aws/request.Request" representing the client's request for the DisableKeyRotation operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisableKeyRotation for more information on using the DisableKeyRotation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DisableKeyRotationRequest method.
req, resp := client.DisableKeyRotationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DisableKeyRotation

func (*KMS) DisableKeyRotationWithContext

func (c *KMS) DisableKeyRotationWithContext(ctx aws.Context, input *DisableKeyRotationInput, opts ...request.Option) (*DisableKeyRotationOutput, error)

DisableKeyRotationWithContext is the same as DisableKeyRotation with the addition of the ability to pass a context and additional request options.

See DisableKeyRotation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) DisableKeyWithContext

func (c *KMS) DisableKeyWithContext(ctx aws.Context, input *DisableKeyInput, opts ...request.Option) (*DisableKeyOutput, error)

DisableKeyWithContext is the same as DisableKey with the addition of the ability to pass a context and additional request options.

See DisableKey for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) DisconnectCustomKeyStore

func (c *KMS) DisconnectCustomKeyStore(input *DisconnectCustomKeyStoreInput) (*DisconnectCustomKeyStoreOutput, error)

DisconnectCustomKeyStore API operation for AWS Key Management Service.

Disconnects the custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) from its associated AWS CloudHSM cluster. While a custom key store is disconnected, you can manage the custom key store and its customer master keys (CMKs), but you cannot create or use CMKs in the custom key store. You can reconnect the custom key store at any time.

While a custom key store is disconnected, all attempts to create customer master keys (CMKs) in the custom key store or to use existing CMKs in cryptographic operations (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) will fail. This action can prevent users from storing and accessing sensitive data.

To find the connection state of a custom key store, use the DescribeCustomKeyStores operation. To reconnect a custom key store, use the ConnectCustomKeyStore operation.

If the operation succeeds, it returns a JSON object with no properties.

This operation is part of the Custom Key Store feature (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation DisconnectCustomKeyStore for usage and error information.

Returned Error Types:

* CustomKeyStoreInvalidStateException
The request was rejected because of the ConnectionState of the custom key
store. To get the ConnectionState of a custom key store, use the DescribeCustomKeyStores
operation.

This exception is thrown under the following conditions:

   * You requested the CreateKey or GenerateRandom operation in a custom
   key store that is not connected. These operations are valid only when
   the custom key store ConnectionState is CONNECTED.

   * You requested the UpdateCustomKeyStore or DeleteCustomKeyStore operation
   on a custom key store that is not disconnected. This operation is valid
   only when the custom key store ConnectionState is DISCONNECTED.

   * You requested the ConnectCustomKeyStore operation on a custom key store
   with a ConnectionState of DISCONNECTING or FAILED. This operation is valid
   for all other ConnectionState values.

* CustomKeyStoreNotFoundException
The request was rejected because AWS KMS cannot find a custom key store with
the specified key store name or ID.

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DisconnectCustomKeyStore

func (*KMS) DisconnectCustomKeyStoreRequest

func (c *KMS) DisconnectCustomKeyStoreRequest(input *DisconnectCustomKeyStoreInput) (req *request.Request, output *DisconnectCustomKeyStoreOutput)

DisconnectCustomKeyStoreRequest generates a "aws/request.Request" representing the client's request for the DisconnectCustomKeyStore operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisconnectCustomKeyStore for more information on using the DisconnectCustomKeyStore API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DisconnectCustomKeyStoreRequest method.
req, resp := client.DisconnectCustomKeyStoreRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DisconnectCustomKeyStore

func (*KMS) DisconnectCustomKeyStoreWithContext

func (c *KMS) DisconnectCustomKeyStoreWithContext(ctx aws.Context, input *DisconnectCustomKeyStoreInput, opts ...request.Option) (*DisconnectCustomKeyStoreOutput, error)

DisconnectCustomKeyStoreWithContext is the same as DisconnectCustomKeyStore with the addition of the ability to pass a context and additional request options.

See DisconnectCustomKeyStore for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) EnableKey

func (c *KMS) EnableKey(input *EnableKeyInput) (*EnableKeyOutput, error)

EnableKey API operation for AWS Key Management Service.

Sets the key state of a customer master key (CMK) to enabled. This allows you to use the CMK for cryptographic operations (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations). You cannot perform this operation on a CMK in a different AWS account.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the AWS Key Management Service Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation EnableKey for usage and error information.

Returned Error Types:

* NotFoundException
The request was rejected because the specified entity or resource could not
be found.

* InvalidArnException
The request was rejected because a specified ARN, or an ARN in a key policy,
is not valid.

* DependencyTimeoutException
The system timed out while trying to fulfill the request. The request can
be retried.

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

* LimitExceededException
The request was rejected because a quota was exceeded. For more information,
see Quotas (https://docs.aws.amazon.com/kms/latest/developerguide/limits.html)
in the AWS Key Management Service Developer Guide.

* InvalidStateException
The request was rejected because the state of the specified resource is not
valid for this request.

For more information about how key state affects the use of a CMK, see How
Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html)
in the AWS Key Management Service Developer Guide .

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/EnableKey

Example (Shared00)

To enable a customer master key (CMK) The following example enables the specified CMK.

Code:

svc := kms.New(session.New())
input := &kms.EnableKeyInput{
    KeyId: aws.String("1234abcd-12ab-34cd-56ef-1234567890ab"),
}

result, err := svc.EnableKey(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case kms.ErrCodeNotFoundException:
            fmt.Println(kms.ErrCodeNotFoundException, aerr.Error())
        case kms.ErrCodeInvalidArnException:
            fmt.Println(kms.ErrCodeInvalidArnException, aerr.Error())
        case kms.ErrCodeDependencyTimeoutException:
            fmt.Println(kms.ErrCodeDependencyTimeoutException, aerr.Error())
        case kms.ErrCodeInternalException:
            fmt.Println(kms.ErrCodeInternalException, aerr.Error())
        case kms.ErrCodeLimitExceededException:
            fmt.Println(kms.ErrCodeLimitExceededException, aerr.Error())
        case kms.ErrCodeInvalidStateException:
            fmt.Println(kms.ErrCodeInvalidStateException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*KMS) EnableKeyRequest

func (c *KMS) EnableKeyRequest(input *EnableKeyInput) (req *request.Request, output *EnableKeyOutput)

EnableKeyRequest generates a "aws/request.Request" representing the client's request for the EnableKey operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See EnableKey for more information on using the EnableKey API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the EnableKeyRequest method.
req, resp := client.EnableKeyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/EnableKey

func (*KMS) EnableKeyRotation

func (c *KMS) EnableKeyRotation(input *EnableKeyRotationInput) (*EnableKeyRotationOutput, error)

EnableKeyRotation API operation for AWS Key Management Service.

Enables automatic rotation of the key material (https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) for the specified symmetric customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.

You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html).

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the AWS Key Management Service Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation EnableKeyRotation for usage and error information.

Returned Error Types:

* NotFoundException
The request was rejected because the specified entity or resource could not
be found.

* DisabledException
The request was rejected because the specified CMK is not enabled.

* InvalidArnException
The request was rejected because a specified ARN, or an ARN in a key policy,
is not valid.

* DependencyTimeoutException
The system timed out while trying to fulfill the request. The request can
be retried.

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

* InvalidStateException
The request was rejected because the state of the specified resource is not
valid for this request.

For more information about how key state affects the use of a CMK, see How
Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html)
in the AWS Key Management Service Developer Guide .

* UnsupportedOperationException
The request was rejected because a specified parameter is not supported or
a specified resource is not valid for this operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/EnableKeyRotation

Example (Shared00)

To enable automatic rotation of key material The following example enables automatic annual rotation of the key material for the specified CMK.

Code:

svc := kms.New(session.New())
input := &kms.EnableKeyRotationInput{
    KeyId: aws.String("1234abcd-12ab-34cd-56ef-1234567890ab"),
}

result, err := svc.EnableKeyRotation(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case kms.ErrCodeNotFoundException:
            fmt.Println(kms.ErrCodeNotFoundException, aerr.Error())
        case kms.ErrCodeDisabledException:
            fmt.Println(kms.ErrCodeDisabledException, aerr.Error())
        case kms.ErrCodeInvalidArnException:
            fmt.Println(kms.ErrCodeInvalidArnException, aerr.Error())
        case kms.ErrCodeDependencyTimeoutException:
            fmt.Println(kms.ErrCodeDependencyTimeoutException, aerr.Error())
        case kms.ErrCodeInternalException:
            fmt.Println(kms.ErrCodeInternalException, aerr.Error())
        case kms.ErrCodeInvalidStateException:
            fmt.Println(kms.ErrCodeInvalidStateException, aerr.Error())
        case kms.ErrCodeUnsupportedOperationException:
            fmt.Println(kms.ErrCodeUnsupportedOperationException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*KMS) EnableKeyRotationRequest

func (c *KMS) EnableKeyRotationRequest(input *EnableKeyRotationInput) (req *request.Request, output *EnableKeyRotationOutput)

EnableKeyRotationRequest generates a "aws/request.Request" representing the client's request for the EnableKeyRotation operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See EnableKeyRotation for more information on using the EnableKeyRotation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the EnableKeyRotationRequest method.
req, resp := client.EnableKeyRotationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/EnableKeyRotation

func (*KMS) EnableKeyRotationWithContext

func (c *KMS) EnableKeyRotationWithContext(ctx aws.Context, input *EnableKeyRotationInput, opts ...request.Option) (*EnableKeyRotationOutput, error)

EnableKeyRotationWithContext is the same as EnableKeyRotation with the addition of the ability to pass a context and additional request options.

See EnableKeyRotation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) EnableKeyWithContext

func (c *KMS) EnableKeyWithContext(ctx aws.Context, input *EnableKeyInput, opts ...request.Option) (*EnableKeyOutput, error)

EnableKeyWithContext is the same as EnableKey with the addition of the ability to pass a context and additional request options.

See EnableKey for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) Encrypt

func (c *KMS) Encrypt(input *EncryptInput) (*EncryptOutput, error)

Encrypt API operation for AWS Key Management Service.

Encrypts plaintext into ciphertext by using a customer master key (CMK). The Encrypt operation has two primary use cases:

* You can encrypt small amounts of arbitrary data, such as a personal
identifier or database password, or other sensitive information.

* You can use the Encrypt operation to move encrypted data from one AWS
Region to another. For example, in Region A, generate a data key and use
the plaintext key to encrypt your data. Then, in Region A, use the Encrypt
operation to encrypt the plaintext data key under a CMK in Region B. Now,
you can move the encrypted data and the encrypted data key to Region B.
When necessary, you can decrypt the encrypted data key and the encrypted
data entirely within in Region B.

You don't need to use the Encrypt operation to encrypt a data key. The GenerateDataKey and GenerateDataKeyPair operations return a plaintext data key and an encrypted copy of that data key.

When you encrypt data, you must specify a symmetric or asymmetric CMK to use in the encryption operation. The CMK must have a KeyUsage value of ENCRYPT_DECRYPT. To find the KeyUsage of a CMK, use the DescribeKey operation.

If you use a symmetric CMK, you can use an encryption context to add additional security to your encryption operation. If you specify an EncryptionContext when encrypting data, you must specify the same encryption context (a case-sensitive exact match) when decrypting the data. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) in the AWS Key Management Service Developer Guide.

If you specify an asymmetric CMK, you must also specify the encryption algorithm. The algorithm must be compatible with the CMK type.

When you use an asymmetric CMK to encrypt or reencrypt data, be sure to record the CMK and encryption algorithm that you choose. You will be required to provide the same CMK and encryption algorithm when you decrypt the data. If the CMK and algorithm do not match the values used to encrypt the data, the decrypt operation fails.

You are not required to supply the CMK ID and encryption algorithm when you decrypt with symmetric CMKs because AWS KMS stores this information in the ciphertext blob. AWS KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields.

The maximum size of the data that you can encrypt varies with the type of CMK and the encryption algorithm that you choose.

* Symmetric CMKs SYMMETRIC_DEFAULT: 4096 bytes

* RSA_2048 RSAES_OAEP_SHA_1: 214 bytes RSAES_OAEP_SHA_256: 190 bytes

* RSA_3072 RSAES_OAEP_SHA_1: 342 bytes RSAES_OAEP_SHA_256: 318 bytes

* RSA_4096 RSAES_OAEP_SHA_1: 470 bytes RSAES_OAEP_SHA_256: 446 bytes

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the AWS Key Management Service Developer Guide.

To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation Encrypt for usage and error information.

Returned Error Types:

* NotFoundException
The request was rejected because the specified entity or resource could not
be found.

* DisabledException
The request was rejected because the specified CMK is not enabled.

* KeyUnavailableException
The request was rejected because the specified CMK was not available. You
can retry the request.

* DependencyTimeoutException
The system timed out while trying to fulfill the request. The request can
be retried.

* InvalidKeyUsageException
The request was rejected for one of the following reasons:

   * The KeyUsage value of the CMK 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 CMK (CustomerMasterKeySpec).

For encrypting, decrypting, re-encrypting, and generating data keys, the
KeyUsage must be ENCRYPT_DECRYPT. For signing and verifying, the KeyUsage
must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation.

To find the encryption or signing algorithms supported for a particular CMK,
use the DescribeKey operation.

* InvalidGrantTokenException
The request was rejected because the specified grant token is not valid.

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

* InvalidStateException
The request was rejected because the state of the specified resource is not
valid for this request.

For more information about how key state affects the use of a CMK, see How
Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html)
in the AWS Key Management Service Developer Guide .

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/Encrypt

Example (Shared00)

To encrypt data The following example encrypts data with the specified customer master key (CMK).

Code:

svc := kms.New(session.New())
input := &kms.EncryptInput{
    KeyId:     aws.String("1234abcd-12ab-34cd-56ef-1234567890ab"),
    Plaintext: []byte("<binary data>"),
}

result, err := svc.Encrypt(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case kms.ErrCodeNotFoundException:
            fmt.Println(kms.ErrCodeNotFoundException, aerr.Error())
        case kms.ErrCodeDisabledException:
            fmt.Println(kms.ErrCodeDisabledException, aerr.Error())
        case kms.ErrCodeKeyUnavailableException:
            fmt.Println(kms.ErrCodeKeyUnavailableException, aerr.Error())
        case kms.ErrCodeDependencyTimeoutException:
            fmt.Println(kms.ErrCodeDependencyTimeoutException, aerr.Error())
        case kms.ErrCodeInvalidKeyUsageException:
            fmt.Println(kms.ErrCodeInvalidKeyUsageException, aerr.Error())
        case kms.ErrCodeInvalidGrantTokenException:
            fmt.Println(kms.ErrCodeInvalidGrantTokenException, aerr.Error())
        case kms.ErrCodeInternalException:
            fmt.Println(kms.ErrCodeInternalException, aerr.Error())
        case kms.ErrCodeInvalidStateException:
            fmt.Println(kms.ErrCodeInvalidStateException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*KMS) EncryptRequest

func (c *KMS) EncryptRequest(input *EncryptInput) (req *request.Request, output *EncryptOutput)

EncryptRequest generates a "aws/request.Request" representing the client's request for the Encrypt operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See Encrypt for more information on using the Encrypt API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the EncryptRequest method.
req, resp := client.EncryptRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/Encrypt

func (*KMS) EncryptWithContext

func (c *KMS) EncryptWithContext(ctx aws.Context, input *EncryptInput, opts ...request.Option) (*EncryptOutput, error)

EncryptWithContext is the same as Encrypt with the addition of the ability to pass a context and additional request options.

See Encrypt for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) GenerateDataKey

func (c *KMS) GenerateDataKey(input *GenerateDataKeyInput) (*GenerateDataKeyOutput, error)

GenerateDataKey API operation for AWS Key Management Service.

Generates a unique symmetric data key for client-side encryption. This operation returns a plaintext copy of the data key and a copy that is encrypted under a customer master key (CMK) that you specify. You can use the plaintext key to encrypt your data outside of AWS KMS and store the encrypted data key with the encrypted data.

GenerateDataKey returns a unique data key for each request. The bytes in the plaintext key are not related to the caller or the CMK.

To generate a data key, specify the symmetric CMK that will be used to encrypt the data key. You cannot use an asymmetric CMK to generate data keys. To get the type of your CMK, use the DescribeKey operation. You must also specify the length of the data key. Use either the KeySpec or NumberOfBytes parameters (but not both). For 128-bit and 256-bit data keys, use the KeySpec parameter.

To get only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To generate an asymmetric data key pair, use the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operation. To get a cryptographically secure random byte string, use GenerateRandom.

You can use the optional encryption context to add additional security to the encryption operation. If you specify an EncryptionContext, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) in the AWS Key Management Service Developer Guide.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the AWS Key Management Service Developer Guide.

How to use your data key

We recommend that you use the following pattern to encrypt data locally in your application. You can write your own code or use a client-side encryption library, such as the AWS Encryption SDK (https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/), the Amazon DynamoDB Encryption Client (https://docs.aws.amazon.com/dynamodb-encryption-client/latest/devguide/), or Amazon S3 client-side encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html) to do these tasks for you.

To encrypt data outside of AWS KMS:

Use the GenerateDataKey operation to get a data key.

Use the plaintext data key (in the Plaintext field of the response) to encrypt your data outside of AWS KMS. Then erase the plaintext data key from memory.

Store the encrypted data key (in the CiphertextBlob field of the response) with the encrypted data.

To decrypt data outside of AWS KMS:

Use the Decrypt operation to decrypt the encrypted data key. The operation returns a plaintext copy of the data key.

Use the plaintext data key to decrypt data outside of AWS KMS, then erase the plaintext data key from memory.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation GenerateDataKey for usage and error information.

Returned Error Types:

* NotFoundException
The request was rejected because the specified entity or resource could not
be found.

* DisabledException
The request was rejected because the specified CMK is not enabled.

* KeyUnavailableException
The request was rejected because the specified CMK was not available. You
can retry the request.

* DependencyTimeoutException
The system timed out while trying to fulfill the request. The request can
be retried.

* InvalidKeyUsageException
The request was rejected for one of the following reasons:

   * The KeyUsage value of the CMK 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 CMK (CustomerMasterKeySpec).

For encrypting, decrypting, re-encrypting, and generating data keys, the
KeyUsage must be ENCRYPT_DECRYPT. For signing and verifying, the KeyUsage
must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation.

To find the encryption or signing algorithms supported for a particular CMK,
use the DescribeKey operation.

* InvalidGrantTokenException
The request was rejected because the specified grant token is not valid.

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

* InvalidStateException
The request was rejected because the state of the specified resource is not
valid for this request.

For more information about how key state affects the use of a CMK, see How
Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html)
in the AWS Key Management Service Developer Guide .

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKey

Example (Shared00)

To generate a data key The following example generates a 256-bit symmetric data encryption key (data key) in two formats. One is the unencrypted (plainext) data key, and the other is the data key encrypted with the specified customer master key (CMK).

Code:

svc := kms.New(session.New())
input := &kms.GenerateDataKeyInput{
    KeyId:   aws.String("alias/ExampleAlias"),
    KeySpec: aws.String("AES_256"),
}

result, err := svc.GenerateDataKey(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case kms.ErrCodeNotFoundException:
            fmt.Println(kms.ErrCodeNotFoundException, aerr.Error())
        case kms.ErrCodeDisabledException:
            fmt.Println(kms.ErrCodeDisabledException, aerr.Error())
        case kms.ErrCodeKeyUnavailableException:
            fmt.Println(kms.ErrCodeKeyUnavailableException, aerr.Error())
        case kms.ErrCodeDependencyTimeoutException:
            fmt.Println(kms.ErrCodeDependencyTimeoutException, aerr.Error())
        case kms.ErrCodeInvalidKeyUsageException:
            fmt.Println(kms.ErrCodeInvalidKeyUsageException, aerr.Error())
        case kms.ErrCodeInvalidGrantTokenException:
            fmt.Println(kms.ErrCodeInvalidGrantTokenException, aerr.Error())
        case kms.ErrCodeInternalException:
            fmt.Println(kms.ErrCodeInternalException, aerr.Error())
        case kms.ErrCodeInvalidStateException:
            fmt.Println(kms.ErrCodeInvalidStateException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*KMS) GenerateDataKeyPair

func (c *KMS) GenerateDataKeyPair(input *GenerateDataKeyPairInput) (*GenerateDataKeyPairOutput, error)

GenerateDataKeyPair API operation for AWS Key Management Service.

Generates a unique asymmetric data key pair. The GenerateDataKeyPair operation returns a plaintext public key, a plaintext private key, and a copy of the private key that is encrypted under the symmetric CMK you specify. You can use the data key pair to perform asymmetric cryptography outside of AWS KMS.

GenerateDataKeyPair returns a unique data key pair for each request. The bytes in the keys are not related to the caller or the CMK that is used to encrypt the private key.

You can use the public key that GenerateDataKeyPair returns to encrypt data or verify a signature outside of AWS KMS. Then, store the encrypted private key with the data. When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.

To generate a data key pair, you must specify a symmetric customer master key (CMK) to encrypt the private key in a data key pair. You cannot use an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your CMK, use the DescribeKey operation.

If you are using the data key pair to encrypt data, or for any operation where you don't immediately need a private key, consider using the GenerateDataKeyPairWithoutPlaintext operation. GenerateDataKeyPairWithoutPlaintext returns a plaintext public key and an encrypted private key, but omits the plaintext private key that you need only to decrypt ciphertext or sign a message. Later, when you need to decrypt the data or sign a message, use the Decrypt operation to decrypt the encrypted private key in the data key pair.

You can use the optional encryption context to add additional security to the encryption operation. If you specify an EncryptionContext, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) in the AWS Key Management Service Developer Guide.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the AWS Key Management Service Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation GenerateDataKeyPair for usage and error information.

Returned Error Types:

* NotFoundException
The request was rejected because the specified entity or resource could not
be found.

* DisabledException
The request was rejected because the specified CMK is not enabled.

* KeyUnavailableException
The request was rejected because the specified CMK was not available. You
can retry the request.

* DependencyTimeoutException
The system timed out while trying to fulfill the request. The request can
be retried.

* InvalidKeyUsageException
The request was rejected for one of the following reasons:

   * The KeyUsage value of the CMK 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 CMK (CustomerMasterKeySpec).

For encrypting, decrypting, re-encrypting, and generating data keys, the
KeyUsage must be ENCRYPT_DECRYPT. For signing and verifying, the KeyUsage
must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation.

To find the encryption or signing algorithms supported for a particular CMK,
use the DescribeKey operation.

* InvalidGrantTokenException
The request was rejected because the specified grant token is not valid.

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

* InvalidStateException
The request was rejected because the state of the specified resource is not
valid for this request.

For more information about how key state affects the use of a CMK, see How
Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html)
in the AWS Key Management Service Developer Guide .

* UnsupportedOperationException
The request was rejected because a specified parameter is not supported or
a specified resource is not valid for this operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyPair

func (*KMS) GenerateDataKeyPairRequest

func (c *KMS) GenerateDataKeyPairRequest(input *GenerateDataKeyPairInput) (req *request.Request, output *GenerateDataKeyPairOutput)

GenerateDataKeyPairRequest generates a "aws/request.Request" representing the client's request for the GenerateDataKeyPair operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GenerateDataKeyPair for more information on using the GenerateDataKeyPair API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GenerateDataKeyPairRequest method.
req, resp := client.GenerateDataKeyPairRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyPair

func (*KMS) GenerateDataKeyPairWithContext

func (c *KMS) GenerateDataKeyPairWithContext(ctx aws.Context, input *GenerateDataKeyPairInput, opts ...request.Option) (*GenerateDataKeyPairOutput, error)

GenerateDataKeyPairWithContext is the same as GenerateDataKeyPair with the addition of the ability to pass a context and additional request options.

See GenerateDataKeyPair for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) GenerateDataKeyPairWithoutPlaintext

func (c *KMS) GenerateDataKeyPairWithoutPlaintext(input *GenerateDataKeyPairWithoutPlaintextInput) (*GenerateDataKeyPairWithoutPlaintextOutput, error)

GenerateDataKeyPairWithoutPlaintext API operation for AWS Key Management Service.

Generates a unique asymmetric data key pair. The GenerateDataKeyPairWithoutPlaintext operation returns a plaintext public key and a copy of the private key that is encrypted under the symmetric CMK you specify. Unlike GenerateDataKeyPair, this operation does not return a plaintext private key.

To generate a data key pair, you must specify a symmetric customer master key (CMK) to encrypt the private key in the data key pair. You cannot use an asymmetric CMK or a CMK in a custom key store. To get the type and origin of your CMK, use the KeySpec field in the DescribeKey response.

You can use the public key that GenerateDataKeyPairWithoutPlaintext returns to encrypt data or verify a signature outside of AWS KMS. Then, store the encrypted private key with the data. When you are ready to decrypt data or sign a message, you can use the Decrypt operation to decrypt the encrypted private key.

GenerateDataKeyPairWithoutPlaintext returns a unique data key pair for each request. The bytes in the key are not related to the caller or CMK that is used to encrypt the private key.

You can use the optional encryption context to add additional security to the encryption operation. If you specify an EncryptionContext, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) in the AWS Key Management Service Developer Guide.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the AWS Key Management Service Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation GenerateDataKeyPairWithoutPlaintext for usage and error information.

Returned Error Types:

* NotFoundException
The request was rejected because the specified entity or resource could not
be found.

* DisabledException
The request was rejected because the specified CMK is not enabled.

* KeyUnavailableException
The request was rejected because the specified CMK was not available. You
can retry the request.

* DependencyTimeoutException
The system timed out while trying to fulfill the request. The request can
be retried.

* InvalidKeyUsageException
The request was rejected for one of the following reasons:

   * The KeyUsage value of the CMK 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 CMK (CustomerMasterKeySpec).

For encrypting, decrypting, re-encrypting, and generating data keys, the
KeyUsage must be ENCRYPT_DECRYPT. For signing and verifying, the KeyUsage
must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation.

To find the encryption or signing algorithms supported for a particular CMK,
use the DescribeKey operation.

* InvalidGrantTokenException
The request was rejected because the specified grant token is not valid.

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

* InvalidStateException
The request was rejected because the state of the specified resource is not
valid for this request.

For more information about how key state affects the use of a CMK, see How
Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html)
in the AWS Key Management Service Developer Guide .

* UnsupportedOperationException
The request was rejected because a specified parameter is not supported or
a specified resource is not valid for this operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyPairWithoutPlaintext

func (*KMS) GenerateDataKeyPairWithoutPlaintextRequest

func (c *KMS) GenerateDataKeyPairWithoutPlaintextRequest(input *GenerateDataKeyPairWithoutPlaintextInput) (req *request.Request, output *GenerateDataKeyPairWithoutPlaintextOutput)

GenerateDataKeyPairWithoutPlaintextRequest generates a "aws/request.Request" representing the client's request for the GenerateDataKeyPairWithoutPlaintext operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GenerateDataKeyPairWithoutPlaintext for more information on using the GenerateDataKeyPairWithoutPlaintext API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GenerateDataKeyPairWithoutPlaintextRequest method.
req, resp := client.GenerateDataKeyPairWithoutPlaintextRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyPairWithoutPlaintext

func (*KMS) GenerateDataKeyPairWithoutPlaintextWithContext

func (c *KMS) GenerateDataKeyPairWithoutPlaintextWithContext(ctx aws.Context, input *GenerateDataKeyPairWithoutPlaintextInput, opts ...request.Option) (*GenerateDataKeyPairWithoutPlaintextOutput, error)

GenerateDataKeyPairWithoutPlaintextWithContext is the same as GenerateDataKeyPairWithoutPlaintext with the addition of the ability to pass a context and additional request options.

See GenerateDataKeyPairWithoutPlaintext for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) GenerateDataKeyRequest

func (c *KMS) GenerateDataKeyRequest(input *GenerateDataKeyInput) (req *request.Request, output *GenerateDataKeyOutput)

GenerateDataKeyRequest generates a "aws/request.Request" representing the client's request for the GenerateDataKey operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GenerateDataKey for more information on using the GenerateDataKey API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GenerateDataKeyRequest method.
req, resp := client.GenerateDataKeyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKey

func (*KMS) GenerateDataKeyWithContext

func (c *KMS) GenerateDataKeyWithContext(ctx aws.Context, input *GenerateDataKeyInput, opts ...request.Option) (*GenerateDataKeyOutput, error)

GenerateDataKeyWithContext is the same as GenerateDataKey with the addition of the ability to pass a context and additional request options.

See GenerateDataKey for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) GenerateDataKeyWithoutPlaintext

func (c *KMS) GenerateDataKeyWithoutPlaintext(input *GenerateDataKeyWithoutPlaintextInput) (*GenerateDataKeyWithoutPlaintextOutput, error)

GenerateDataKeyWithoutPlaintext API operation for AWS Key Management Service.

Generates a unique symmetric data key. This operation returns a data key that is encrypted under a customer master key (CMK) that you specify. To request an asymmetric data key pair, use the GenerateDataKeyPair or GenerateDataKeyPairWithoutPlaintext operations.

GenerateDataKeyWithoutPlaintext is identical to the GenerateDataKey operation except that returns only the encrypted copy of the data key. This operation is useful for systems that need to encrypt data at some point, but not immediately. When you need to encrypt the data, you call the Decrypt operation on the encrypted copy of the key.

It's also useful in distributed systems with different levels of trust. For example, you might store encrypted data in containers. One component of your system creates new containers and stores an encrypted data key with each container. Then, a different component puts the data into the containers. That component first decrypts the data key, uses the plaintext data key to encrypt data, puts the encrypted data into the container, and then destroys the plaintext data key. In this system, the component that creates the containers never sees the plaintext data key.

GenerateDataKeyWithoutPlaintext returns a unique data key for each request. The bytes in the keys are not related to the caller or CMK that is used to encrypt the private key.

To generate a data key, you must specify the symmetric customer master key (CMK) that is used to encrypt the data key. You cannot use an asymmetric CMK to generate a data key. To get the type of your CMK, use the DescribeKey operation.

If the operation succeeds, you will find the encrypted copy of the data key in the CiphertextBlob field.

You can use the optional encryption context to add additional security to the encryption operation. If you specify an EncryptionContext, you must specify the same encryption context (a case-sensitive exact match) when decrypting the encrypted data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) in the AWS Key Management Service Developer Guide.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the AWS Key Management Service Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation GenerateDataKeyWithoutPlaintext for usage and error information.

Returned Error Types:

* NotFoundException
The request was rejected because the specified entity or resource could not
be found.

* DisabledException
The request was rejected because the specified CMK is not enabled.

* KeyUnavailableException
The request was rejected because the specified CMK was not available. You
can retry the request.

* DependencyTimeoutException
The system timed out while trying to fulfill the request. The request can
be retried.

* InvalidKeyUsageException
The request was rejected for one of the following reasons:

   * The KeyUsage value of the CMK 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 CMK (CustomerMasterKeySpec).

For encrypting, decrypting, re-encrypting, and generating data keys, the
KeyUsage must be ENCRYPT_DECRYPT. For signing and verifying, the KeyUsage
must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation.

To find the encryption or signing algorithms supported for a particular CMK,
use the DescribeKey operation.

* InvalidGrantTokenException
The request was rejected because the specified grant token is not valid.

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

* InvalidStateException
The request was rejected because the state of the specified resource is not
valid for this request.

For more information about how key state affects the use of a CMK, see How
Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html)
in the AWS Key Management Service Developer Guide .

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyWithoutPlaintext

Example (Shared00)

To generate an encrypted data key The following example generates an encrypted copy of a 256-bit symmetric data encryption key (data key). The data key is encrypted with the specified customer master key (CMK).

Code:

svc := kms.New(session.New())
input := &kms.GenerateDataKeyWithoutPlaintextInput{
    KeyId:   aws.String("alias/ExampleAlias"),
    KeySpec: aws.String("AES_256"),
}

result, err := svc.GenerateDataKeyWithoutPlaintext(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case kms.ErrCodeNotFoundException:
            fmt.Println(kms.ErrCodeNotFoundException, aerr.Error())
        case kms.ErrCodeDisabledException:
            fmt.Println(kms.ErrCodeDisabledException, aerr.Error())
        case kms.ErrCodeKeyUnavailableException:
            fmt.Println(kms.ErrCodeKeyUnavailableException, aerr.Error())
        case kms.ErrCodeDependencyTimeoutException:
            fmt.Println(kms.ErrCodeDependencyTimeoutException, aerr.Error())
        case kms.ErrCodeInvalidKeyUsageException:
            fmt.Println(kms.ErrCodeInvalidKeyUsageException, aerr.Error())
        case kms.ErrCodeInvalidGrantTokenException:
            fmt.Println(kms.ErrCodeInvalidGrantTokenException, aerr.Error())
        case kms.ErrCodeInternalException:
            fmt.Println(kms.ErrCodeInternalException, aerr.Error())
        case kms.ErrCodeInvalidStateException:
            fmt.Println(kms.ErrCodeInvalidStateException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*KMS) GenerateDataKeyWithoutPlaintextRequest

func (c *KMS) GenerateDataKeyWithoutPlaintextRequest(input *GenerateDataKeyWithoutPlaintextInput) (req *request.Request, output *GenerateDataKeyWithoutPlaintextOutput)

GenerateDataKeyWithoutPlaintextRequest generates a "aws/request.Request" representing the client's request for the GenerateDataKeyWithoutPlaintext operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GenerateDataKeyWithoutPlaintext for more information on using the GenerateDataKeyWithoutPlaintext API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GenerateDataKeyWithoutPlaintextRequest method.
req, resp := client.GenerateDataKeyWithoutPlaintextRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateDataKeyWithoutPlaintext

func (*KMS) GenerateDataKeyWithoutPlaintextWithContext

func (c *KMS) GenerateDataKeyWithoutPlaintextWithContext(ctx aws.Context, input *GenerateDataKeyWithoutPlaintextInput, opts ...request.Option) (*GenerateDataKeyWithoutPlaintextOutput, error)

GenerateDataKeyWithoutPlaintextWithContext is the same as GenerateDataKeyWithoutPlaintext with the addition of the ability to pass a context and additional request options.

See GenerateDataKeyWithoutPlaintext for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) GenerateRandom

func (c *KMS) GenerateRandom(input *GenerateRandomInput) (*GenerateRandomOutput, error)

GenerateRandom API operation for AWS Key Management Service.

Returns a random byte string that is cryptographically secure.

By default, the random byte string is generated in AWS KMS. To generate the byte string in the AWS CloudHSM cluster that is associated with a custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html), specify the custom key store ID.

For more information about entropy and random number generation, see the AWS Key Management Service Cryptographic Details (https://d0.awsstatic.com/whitepapers/KMS-Cryptographic-Details.pdf) whitepaper.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation GenerateRandom for usage and error information.

Returned Error Types:

* DependencyTimeoutException
The system timed out while trying to fulfill the request. The request can
be retried.

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

* CustomKeyStoreNotFoundException
The request was rejected because AWS KMS cannot find a custom key store with
the specified key store name or ID.

* CustomKeyStoreInvalidStateException
The request was rejected because of the ConnectionState of the custom key
store. To get the ConnectionState of a custom key store, use the DescribeCustomKeyStores
operation.

This exception is thrown under the following conditions:

   * You requested the CreateKey or GenerateRandom operation in a custom
   key store that is not connected. These operations are valid only when
   the custom key store ConnectionState is CONNECTED.

   * You requested the UpdateCustomKeyStore or DeleteCustomKeyStore operation
   on a custom key store that is not disconnected. This operation is valid
   only when the custom key store ConnectionState is DISCONNECTED.

   * You requested the ConnectCustomKeyStore operation on a custom key store
   with a ConnectionState of DISCONNECTING or FAILED. This operation is valid
   for all other ConnectionState values.

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateRandom

Example (Shared00)

To generate random data The following example uses AWS KMS to generate 32 bytes of random data.

Code:

svc := kms.New(session.New())
input := &kms.GenerateRandomInput{
    NumberOfBytes: aws.Int64(32),
}

result, err := svc.GenerateRandom(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case kms.ErrCodeDependencyTimeoutException:
            fmt.Println(kms.ErrCodeDependencyTimeoutException, aerr.Error())
        case kms.ErrCodeInternalException:
            fmt.Println(kms.ErrCodeInternalException, aerr.Error())
        case kms.ErrCodeCustomKeyStoreNotFoundException:
            fmt.Println(kms.ErrCodeCustomKeyStoreNotFoundException, aerr.Error())
        case kms.ErrCodeCustomKeyStoreInvalidStateException:
            fmt.Println(kms.ErrCodeCustomKeyStoreInvalidStateException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*KMS) GenerateRandomRequest

func (c *KMS) GenerateRandomRequest(input *GenerateRandomInput) (req *request.Request, output *GenerateRandomOutput)

GenerateRandomRequest generates a "aws/request.Request" representing the client's request for the GenerateRandom operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GenerateRandom for more information on using the GenerateRandom API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GenerateRandomRequest method.
req, resp := client.GenerateRandomRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GenerateRandom

func (*KMS) GenerateRandomWithContext

func (c *KMS) GenerateRandomWithContext(ctx aws.Context, input *GenerateRandomInput, opts ...request.Option) (*GenerateRandomOutput, error)

GenerateRandomWithContext is the same as GenerateRandom with the addition of the ability to pass a context and additional request options.

See GenerateRandom for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) GetKeyPolicy

func (c *KMS) GetKeyPolicy(input *GetKeyPolicyInput) (*GetKeyPolicyOutput, error)

GetKeyPolicy API operation for AWS Key Management Service.

Gets a key policy attached to the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation GetKeyPolicy for usage and error information.

Returned Error Types:

* NotFoundException
The request was rejected because the specified entity or resource could not
be found.

* InvalidArnException
The request was rejected because a specified ARN, or an ARN in a key policy,
is not valid.

* DependencyTimeoutException
The system timed out while trying to fulfill the request. The request can
be retried.

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

* InvalidStateException
The request was rejected because the state of the specified resource is not
valid for this request.

For more information about how key state affects the use of a CMK, see How
Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html)
in the AWS Key Management Service Developer Guide .

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetKeyPolicy

Example (Shared00)

To retrieve a key policy The following example retrieves the key policy for the specified customer master key (CMK).

Code:

svc := kms.New(session.New())
input := &kms.GetKeyPolicyInput{
    KeyId:      aws.String("1234abcd-12ab-34cd-56ef-1234567890ab"),
    PolicyName: aws.String("default"),
}

result, err := svc.GetKeyPolicy(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case kms.ErrCodeNotFoundException:
            fmt.Println(kms.ErrCodeNotFoundException, aerr.Error())
        case kms.ErrCodeInvalidArnException:
            fmt.Println(kms.ErrCodeInvalidArnException, aerr.Error())
        case kms.ErrCodeDependencyTimeoutException:
            fmt.Println(kms.ErrCodeDependencyTimeoutException, aerr.Error())
        case kms.ErrCodeInternalException:
            fmt.Println(kms.ErrCodeInternalException, aerr.Error())
        case kms.ErrCodeInvalidStateException:
            fmt.Println(kms.ErrCodeInvalidStateException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*KMS) GetKeyPolicyRequest

func (c *KMS) GetKeyPolicyRequest(input *GetKeyPolicyInput) (req *request.Request, output *GetKeyPolicyOutput)

GetKeyPolicyRequest generates a "aws/request.Request" representing the client's request for the GetKeyPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetKeyPolicy for more information on using the GetKeyPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetKeyPolicyRequest method.
req, resp := client.GetKeyPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetKeyPolicy

func (*KMS) GetKeyPolicyWithContext

func (c *KMS) GetKeyPolicyWithContext(ctx aws.Context, input *GetKeyPolicyInput, opts ...request.Option) (*GetKeyPolicyOutput, error)

GetKeyPolicyWithContext is the same as GetKeyPolicy with the addition of the ability to pass a context and additional request options.

See GetKeyPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) GetKeyRotationStatus

func (c *KMS) GetKeyRotationStatus(input *GetKeyRotationStatusInput) (*GetKeyRotationStatusOutput, error)

GetKeyRotationStatus API operation for AWS Key Management Service.

Gets a Boolean value that indicates whether automatic rotation of the key material (https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) is enabled for the specified customer master key (CMK).

You cannot enable automatic rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html). The key rotation status for these CMKs is always false.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the AWS Key Management Service Developer Guide.

* Disabled: The key rotation status does not change when you disable a
CMK. However, while the CMK is disabled, AWS KMS does not rotate the backing
key.

* Pending deletion: While a CMK is pending deletion, its key rotation
status is false and AWS KMS does not rotate the backing key. If you cancel
the deletion, the original key rotation status is restored.

To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation GetKeyRotationStatus for usage and error information.

Returned Error Types:

* NotFoundException
The request was rejected because the specified entity or resource could not
be found.

* InvalidArnException
The request was rejected because a specified ARN, or an ARN in a key policy,
is not valid.

* DependencyTimeoutException
The system timed out while trying to fulfill the request. The request can
be retried.

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

* InvalidStateException
The request was rejected because the state of the specified resource is not
valid for this request.

For more information about how key state affects the use of a CMK, see How
Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html)
in the AWS Key Management Service Developer Guide .

* UnsupportedOperationException
The request was rejected because a specified parameter is not supported or
a specified resource is not valid for this operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetKeyRotationStatus

Example (Shared00)

To retrieve the rotation status for a customer master key (CMK) The following example retrieves the status of automatic annual rotation of the key material for the specified CMK.

Code:

svc := kms.New(session.New())
input := &kms.GetKeyRotationStatusInput{
    KeyId: aws.String("1234abcd-12ab-34cd-56ef-1234567890ab"),
}

result, err := svc.GetKeyRotationStatus(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case kms.ErrCodeNotFoundException:
            fmt.Println(kms.ErrCodeNotFoundException, aerr.Error())
        case kms.ErrCodeInvalidArnException:
            fmt.Println(kms.ErrCodeInvalidArnException, aerr.Error())
        case kms.ErrCodeDependencyTimeoutException:
            fmt.Println(kms.ErrCodeDependencyTimeoutException, aerr.Error())
        case kms.ErrCodeInternalException:
            fmt.Println(kms.ErrCodeInternalException, aerr.Error())
        case kms.ErrCodeInvalidStateException:
            fmt.Println(kms.ErrCodeInvalidStateException, aerr.Error())
        case kms.ErrCodeUnsupportedOperationException:
            fmt.Println(kms.ErrCodeUnsupportedOperationException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*KMS) GetKeyRotationStatusRequest

func (c *KMS) GetKeyRotationStatusRequest(input *GetKeyRotationStatusInput) (req *request.Request, output *GetKeyRotationStatusOutput)

GetKeyRotationStatusRequest generates a "aws/request.Request" representing the client's request for the GetKeyRotationStatus operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetKeyRotationStatus for more information on using the GetKeyRotationStatus API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetKeyRotationStatusRequest method.
req, resp := client.GetKeyRotationStatusRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetKeyRotationStatus

func (*KMS) GetKeyRotationStatusWithContext

func (c *KMS) GetKeyRotationStatusWithContext(ctx aws.Context, input *GetKeyRotationStatusInput, opts ...request.Option) (*GetKeyRotationStatusOutput, error)

GetKeyRotationStatusWithContext is the same as GetKeyRotationStatus with the addition of the ability to pass a context and additional request options.

See GetKeyRotationStatus for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) GetParametersForImport

func (c *KMS) GetParametersForImport(input *GetParametersForImportInput) (*GetParametersForImportOutput, error)

GetParametersForImport API operation for AWS Key Management Service.

Returns the items you need to import key material into a symmetric, customer managed customer master key (CMK). For more information about importing key material into AWS KMS, see Importing Key Material (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) in the AWS Key Management Service Developer Guide.

This operation returns a public key and an import token. Use the public key to encrypt the symmetric key material. Store the import token to send with a subsequent ImportKeyMaterial request.

You must specify the key ID of the symmetric CMK into which you will import key material. This CMK's Origin must be EXTERNAL. You must also specify the wrapping algorithm and type of wrapping key (public key) that you will use to encrypt the key material. You cannot perform this operation on an asymmetric CMK or on any CMK in a different AWS account.

To import key material, you must use the public key and import token from the same response. These items are valid for 24 hours. The expiration date and time appear in the GetParametersForImport response. You cannot use an expired token in an ImportKeyMaterial request. If your key and token expire, send another GetParametersForImport request.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the AWS Key Management Service Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation GetParametersForImport for usage and error information.

Returned Error Types:

* InvalidArnException
The request was rejected because a specified ARN, or an ARN in a key policy,
is not valid.

* UnsupportedOperationException
The request was rejected because a specified parameter is not supported or
a specified resource is not valid for this operation.

* DependencyTimeoutException
The system timed out while trying to fulfill the request. The request can
be retried.

* NotFoundException
The request was rejected because the specified entity or resource could not
be found.

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

* InvalidStateException
The request was rejected because the state of the specified resource is not
valid for this request.

For more information about how key state affects the use of a CMK, see How
Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html)
in the AWS Key Management Service Developer Guide .

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetParametersForImport

Example (Shared00)

To retrieve the public key and import token for a customer master key (CMK) The following example retrieves the public key and import token for the specified CMK.

Code:

svc := kms.New(session.New())
input := &kms.GetParametersForImportInput{
    KeyId:             aws.String("1234abcd-12ab-34cd-56ef-1234567890ab"),
    WrappingAlgorithm: aws.String("RSAES_OAEP_SHA_1"),
    WrappingKeySpec:   aws.String("RSA_2048"),
}

result, err := svc.GetParametersForImport(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case kms.ErrCodeInvalidArnException:
            fmt.Println(kms.ErrCodeInvalidArnException, aerr.Error())
        case kms.ErrCodeUnsupportedOperationException:
            fmt.Println(kms.ErrCodeUnsupportedOperationException, aerr.Error())
        case kms.ErrCodeDependencyTimeoutException:
            fmt.Println(kms.ErrCodeDependencyTimeoutException, aerr.Error())
        case kms.ErrCodeNotFoundException:
            fmt.Println(kms.ErrCodeNotFoundException, aerr.Error())
        case kms.ErrCodeInternalException:
            fmt.Println(kms.ErrCodeInternalException, aerr.Error())
        case kms.ErrCodeInvalidStateException:
            fmt.Println(kms.ErrCodeInvalidStateException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*KMS) GetParametersForImportRequest

func (c *KMS) GetParametersForImportRequest(input *GetParametersForImportInput) (req *request.Request, output *GetParametersForImportOutput)

GetParametersForImportRequest generates a "aws/request.Request" representing the client's request for the GetParametersForImport operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetParametersForImport for more information on using the GetParametersForImport API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetParametersForImportRequest method.
req, resp := client.GetParametersForImportRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetParametersForImport

func (*KMS) GetParametersForImportWithContext

func (c *KMS) GetParametersForImportWithContext(ctx aws.Context, input *GetParametersForImportInput, opts ...request.Option) (*GetParametersForImportOutput, error)

GetParametersForImportWithContext is the same as GetParametersForImport with the addition of the ability to pass a context and additional request options.

See GetParametersForImport for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) GetPublicKey

func (c *KMS) GetPublicKey(input *GetPublicKeyInput) (*GetPublicKeyOutput, error)

GetPublicKey API operation for AWS Key Management Service.

Returns the public key of an asymmetric CMK. Unlike the private key of a asymmetric CMK, which never leaves AWS KMS unencrypted, callers with kms:GetPublicKey permission can download the public key of an asymmetric CMK. You can share the public key to allow others to encrypt messages and verify signatures outside of AWS KMS. For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) in the AWS Key Management Service Developer Guide.

You do not need to download the public key. Instead, you can use the public key within AWS KMS by calling the Encrypt, ReEncrypt, or Verify operations with the identifier of an asymmetric CMK. When you use the public key within AWS KMS, you benefit from the authentication, authorization, and logging that are part of every AWS KMS operation. You also reduce of risk of encrypting data that cannot be decrypted. These features are not effective outside of AWS KMS. For details, see Special Considerations for Downloading Public Keys (https://docs.aws.amazon.com/kms/latest/developerguide/download-public-key.html#download-public-key-considerations).

To help you use the public key safely outside of AWS KMS, GetPublicKey returns important information about the public key in the response, including:

* CustomerMasterKeySpec (https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-CustomerMasterKeySpec):
The type of key material in the public key, such as RSA_4096 or ECC_NIST_P521.

* KeyUsage (https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-KeyUsage):
Whether the key is used for encryption or signing.

* EncryptionAlgorithms (https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-EncryptionAlgorithms)
or SigningAlgorithms (https://docs.aws.amazon.com/kms/latest/APIReference/API_GetPublicKey.html#KMS-GetPublicKey-response-SigningAlgorithms):
A list of the encryption algorithms or the signing algorithms for the
key.

Although AWS KMS cannot enforce these restrictions on external operations, it is crucial that you use this information to prevent the public key from being used improperly. For example, you can prevent a public signing key from being used encrypt data, or prevent a public key from being used with an encryption algorithm that is not supported by AWS KMS. You can also avoid errors, such as using the wrong signing algorithm in a verification operation.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the AWS Key Management Service Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation GetPublicKey for usage and error information.

Returned Error Types:

* NotFoundException
The request was rejected because the specified entity or resource could not
be found.

* DisabledException
The request was rejected because the specified CMK is not enabled.

* KeyUnavailableException
The request was rejected because the specified CMK was not available. You
can retry the request.

* DependencyTimeoutException
The system timed out while trying to fulfill the request. The request can
be retried.

* UnsupportedOperationException
The request was rejected because a specified parameter is not supported or
a specified resource is not valid for this operation.

* InvalidArnException
The request was rejected because a specified ARN, or an ARN in a key policy,
is not valid.

* InvalidGrantTokenException
The request was rejected because the specified grant token is not valid.

* InvalidKeyUsageException
The request was rejected for one of the following reasons:

   * The KeyUsage value of the CMK 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 CMK (CustomerMasterKeySpec).

For encrypting, decrypting, re-encrypting, and generating data keys, the
KeyUsage must be ENCRYPT_DECRYPT. For signing and verifying, the KeyUsage
must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation.

To find the encryption or signing algorithms supported for a particular CMK,
use the DescribeKey operation.

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

* InvalidStateException
The request was rejected because the state of the specified resource is not
valid for this request.

For more information about how key state affects the use of a CMK, see How
Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html)
in the AWS Key Management Service Developer Guide .

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetPublicKey

func (*KMS) GetPublicKeyRequest

func (c *KMS) GetPublicKeyRequest(input *GetPublicKeyInput) (req *request.Request, output *GetPublicKeyOutput)

GetPublicKeyRequest generates a "aws/request.Request" representing the client's request for the GetPublicKey operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetPublicKey for more information on using the GetPublicKey API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetPublicKeyRequest method.
req, resp := client.GetPublicKeyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/GetPublicKey

func (*KMS) GetPublicKeyWithContext

func (c *KMS) GetPublicKeyWithContext(ctx aws.Context, input *GetPublicKeyInput, opts ...request.Option) (*GetPublicKeyOutput, error)

GetPublicKeyWithContext is the same as GetPublicKey with the addition of the ability to pass a context and additional request options.

See GetPublicKey for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) ImportKeyMaterial

func (c *KMS) ImportKeyMaterial(input *ImportKeyMaterialInput) (*ImportKeyMaterialOutput, error)

ImportKeyMaterial API operation for AWS Key Management Service.

Imports key material into an existing symmetric AWS KMS customer master key (CMK) that was created without key material. After you successfully import key material into a CMK, you can reimport the same key material (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html#reimport-key-material) into that CMK, but you cannot import different key material.

You cannot perform this operation on an asymmetric CMK or on any CMK in a different AWS account. For more information about creating CMKs with no key material and then importing key material, see Importing Key Material (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) in the AWS Key Management Service Developer Guide.

Before using this operation, call GetParametersForImport. Its response includes a public key and an import token. Use the public key to encrypt the key material. Then, submit the import token from the same GetParametersForImport response.

When calling this operation, you must specify the following values:

* The key ID or key ARN of a CMK with no key material. Its Origin must
be EXTERNAL. To create a CMK with no key material, call CreateKey and
set the value of its Origin parameter to EXTERNAL. To get the Origin of
a CMK, call DescribeKey.)

* The encrypted key material. To get the public key to encrypt the key
material, call GetParametersForImport.

* The import token that GetParametersForImport returned. You must use
a public key and token from the same GetParametersForImport response.

* Whether the key material expires and if so, when. If you set an expiration
date, AWS KMS deletes the key material from the CMK on the specified date,
and the CMK becomes unusable. To use the CMK again, you must reimport
the same key material. The only way to change an expiration date is by
reimporting the same key material and specifying a new expiration date.

When this operation is successful, the key state of the CMK changes from PendingImport to Enabled, and you can use the CMK.

If this operation fails, use the exception to help determine the problem. If the error is related to the key material, the import token, or wrapping key, use GetParametersForImport to get a new public key and import token for the CMK and repeat the import procedure. For help, see How To Import Key Material (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html#importing-keys-overview) in the AWS Key Management Service Developer Guide.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the AWS Key Management Service Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation ImportKeyMaterial for usage and error information.

Returned Error Types:

* InvalidArnException
The request was rejected because a specified ARN, or an ARN in a key policy,
is not valid.

* UnsupportedOperationException
The request was rejected because a specified parameter is not supported or
a specified resource is not valid for this operation.

* DependencyTimeoutException
The system timed out while trying to fulfill the request. The request can
be retried.

* NotFoundException
The request was rejected because the specified entity or resource could not
be found.

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

* InvalidStateException
The request was rejected because the state of the specified resource is not
valid for this request.

For more information about how key state affects the use of a CMK, see How
Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html)
in the AWS Key Management Service Developer Guide .

* InvalidCiphertextException
From the Decrypt or ReEncrypt operation, the request was rejected because
the specified ciphertext, or additional authenticated data incorporated into
the ciphertext, such as the encryption context, is corrupted, missing, or
otherwise invalid.

From the ImportKeyMaterial operation, the request was rejected because AWS
KMS could not decrypt the encrypted (wrapped) key material.

* IncorrectKeyMaterialException
The request was rejected because the key material in the request is, expired,
invalid, or is not the same key material that was previously imported into
this customer master key (CMK).

* ExpiredImportTokenException
The request was rejected because the specified import token is expired. Use
GetParametersForImport to get a new import token and public key, use the
new public key to encrypt the key material, and then try the request again.

* InvalidImportTokenException
The request was rejected because the provided import token is invalid or
is associated with a different customer master key (CMK).

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ImportKeyMaterial

Example (Shared00)

To import key material into a customer master key (CMK) The following example imports key material into the specified CMK.

Code:

svc := kms.New(session.New())
input := &kms.ImportKeyMaterialInput{
    EncryptedKeyMaterial: []byte("<binary data>"),
    ExpirationModel:      aws.String("KEY_MATERIAL_DOES_NOT_EXPIRE"),
    ImportToken:          []byte("<binary data>"),
    KeyId:                aws.String("1234abcd-12ab-34cd-56ef-1234567890ab"),
}

result, err := svc.ImportKeyMaterial(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case kms.ErrCodeInvalidArnException:
            fmt.Println(kms.ErrCodeInvalidArnException, aerr.Error())
        case kms.ErrCodeUnsupportedOperationException:
            fmt.Println(kms.ErrCodeUnsupportedOperationException, aerr.Error())
        case kms.ErrCodeDependencyTimeoutException:
            fmt.Println(kms.ErrCodeDependencyTimeoutException, aerr.Error())
        case kms.ErrCodeNotFoundException:
            fmt.Println(kms.ErrCodeNotFoundException, aerr.Error())
        case kms.ErrCodeInternalException:
            fmt.Println(kms.ErrCodeInternalException, aerr.Error())
        case kms.ErrCodeInvalidStateException:
            fmt.Println(kms.ErrCodeInvalidStateException, aerr.Error())
        case kms.ErrCodeInvalidCiphertextException:
            fmt.Println(kms.ErrCodeInvalidCiphertextException, aerr.Error())
        case kms.ErrCodeIncorrectKeyMaterialException:
            fmt.Println(kms.ErrCodeIncorrectKeyMaterialException, aerr.Error())
        case kms.ErrCodeExpiredImportTokenException:
            fmt.Println(kms.ErrCodeExpiredImportTokenException, aerr.Error())
        case kms.ErrCodeInvalidImportTokenException:
            fmt.Println(kms.ErrCodeInvalidImportTokenException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*KMS) ImportKeyMaterialRequest

func (c *KMS) ImportKeyMaterialRequest(input *ImportKeyMaterialInput) (req *request.Request, output *ImportKeyMaterialOutput)

ImportKeyMaterialRequest generates a "aws/request.Request" representing the client's request for the ImportKeyMaterial operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ImportKeyMaterial for more information on using the ImportKeyMaterial API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ImportKeyMaterialRequest method.
req, resp := client.ImportKeyMaterialRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ImportKeyMaterial

func (*KMS) ImportKeyMaterialWithContext

func (c *KMS) ImportKeyMaterialWithContext(ctx aws.Context, input *ImportKeyMaterialInput, opts ...request.Option) (*ImportKeyMaterialOutput, error)

ImportKeyMaterialWithContext is the same as ImportKeyMaterial with the addition of the ability to pass a context and additional request options.

See ImportKeyMaterial for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) ListAliases

func (c *KMS) ListAliases(input *ListAliasesInput) (*ListAliasesOutput, error)

ListAliases API operation for AWS Key Management Service.

Gets a list of aliases in the caller's AWS account and region. You cannot list aliases in other accounts. For more information about aliases, see CreateAlias.

By default, the ListAliases command returns all aliases in the account and region. To get only the aliases that point to a particular customer master key (CMK), use the KeyId parameter.

The ListAliases response can include aliases that you created and associated with your customer managed CMKs, and aliases that AWS created and associated with AWS managed CMKs in your account. You can recognize AWS aliases because their names have the format aws/<service-name>, such as aws/dynamodb.

The response might also include aliases that have no TargetKeyId field. These are predefined aliases that AWS has created but has not yet associated with a CMK. Aliases that AWS creates in your account, including predefined aliases, do not count against your AWS KMS aliases quota (https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#aliases-limit).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation ListAliases for usage and error information.

Returned Error Types:

* DependencyTimeoutException
The system timed out while trying to fulfill the request. The request can
be retried.

* InvalidMarkerException
The request was rejected because the marker that specifies where pagination
should next begin is not valid.

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

* InvalidArnException
The request was rejected because a specified ARN, or an ARN in a key policy,
is not valid.

* NotFoundException
The request was rejected because the specified entity or resource could not
be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListAliases

Example (Shared00)

To list aliases The following example lists aliases.

Code:

svc := kms.New(session.New())
input := &kms.ListAliasesInput{}

result, err := svc.ListAliases(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case kms.ErrCodeDependencyTimeoutException:
            fmt.Println(kms.ErrCodeDependencyTimeoutException, aerr.Error())
        case kms.ErrCodeInvalidMarkerException:
            fmt.Println(kms.ErrCodeInvalidMarkerException, aerr.Error())
        case kms.ErrCodeInternalException:
            fmt.Println(kms.ErrCodeInternalException, aerr.Error())
        case kms.ErrCodeInvalidArnException:
            fmt.Println(kms.ErrCodeInvalidArnException, aerr.Error())
        case kms.ErrCodeNotFoundException:
            fmt.Println(kms.ErrCodeNotFoundException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*KMS) ListAliasesPages

func (c *KMS) ListAliasesPages(input *ListAliasesInput, fn func(*ListAliasesOutput, bool) bool) error

ListAliasesPages iterates over the pages of a ListAliases operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAliases method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListAliases operation.
pageNum := 0
err := client.ListAliasesPages(params,
    func(page *kms.ListAliasesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*KMS) ListAliasesPagesWithContext

func (c *KMS) ListAliasesPagesWithContext(ctx aws.Context, input *ListAliasesInput, fn func(*ListAliasesOutput, bool) bool, opts ...request.Option) error

ListAliasesPagesWithContext same as ListAliasesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) ListAliasesRequest

func (c *KMS) ListAliasesRequest(input *ListAliasesInput) (req *request.Request, output *ListAliasesOutput)

ListAliasesRequest generates a "aws/request.Request" representing the client's request for the ListAliases operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListAliases for more information on using the ListAliases API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListAliasesRequest method.
req, resp := client.ListAliasesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListAliases

func (*KMS) ListAliasesWithContext

func (c *KMS) ListAliasesWithContext(ctx aws.Context, input *ListAliasesInput, opts ...request.Option) (*ListAliasesOutput, error)

ListAliasesWithContext is the same as ListAliases with the addition of the ability to pass a context and additional request options.

See ListAliases for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) ListGrants

func (c *KMS) ListGrants(input *ListGrantsInput) (*ListGrantsResponse, error)

ListGrants API operation for AWS Key Management Service.

Gets a list of all grants for the specified customer master key (CMK).

To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter.

The GranteePrincipal field in the ListGrants response usually contains the user or role designated as the grantee principal in the grant. However, when the grantee principal in the grant is an AWS service, the GranteePrincipal field contains the service principal (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services), which might represent several different grantee principals.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation ListGrants for usage and error information.

Returned Error Types:

* NotFoundException
The request was rejected because the specified entity or resource could not
be found.

* DependencyTimeoutException
The system timed out while trying to fulfill the request. The request can
be retried.

* InvalidMarkerException
The request was rejected because the marker that specifies where pagination
should next begin is not valid.

* InvalidArnException
The request was rejected because a specified ARN, or an ARN in a key policy,
is not valid.

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

* InvalidStateException
The request was rejected because the state of the specified resource is not
valid for this request.

For more information about how key state affects the use of a CMK, see How
Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html)
in the AWS Key Management Service Developer Guide .

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListGrants

Example (Shared00)

To list grants for a customer master key (CMK) The following example lists grants for the specified CMK.

Code:

svc := kms.New(session.New())
input := &kms.ListGrantsInput{
    KeyId: aws.String("1234abcd-12ab-34cd-56ef-1234567890ab"),
}

result, err := svc.ListGrants(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case kms.ErrCodeNotFoundException:
            fmt.Println(kms.ErrCodeNotFoundException, aerr.Error())
        case kms.ErrCodeDependencyTimeoutException:
            fmt.Println(kms.ErrCodeDependencyTimeoutException, aerr.Error())
        case kms.ErrCodeInvalidMarkerException:
            fmt.Println(kms.ErrCodeInvalidMarkerException, aerr.Error())
        case kms.ErrCodeInvalidArnException:
            fmt.Println(kms.ErrCodeInvalidArnException, aerr.Error())
        case kms.ErrCodeInternalException:
            fmt.Println(kms.ErrCodeInternalException, aerr.Error())
        case kms.ErrCodeInvalidStateException:
            fmt.Println(kms.ErrCodeInvalidStateException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*KMS) ListGrantsPages

func (c *KMS) ListGrantsPages(input *ListGrantsInput, fn func(*ListGrantsResponse, bool) bool) error

ListGrantsPages iterates over the pages of a ListGrants operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListGrants method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListGrants operation.
pageNum := 0
err := client.ListGrantsPages(params,
    func(page *kms.ListGrantsResponse, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*KMS) ListGrantsPagesWithContext

func (c *KMS) ListGrantsPagesWithContext(ctx aws.Context, input *ListGrantsInput, fn func(*ListGrantsResponse, bool) bool, opts ...request.Option) error

ListGrantsPagesWithContext same as ListGrantsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) ListGrantsRequest

func (c *KMS) ListGrantsRequest(input *ListGrantsInput) (req *request.Request, output *ListGrantsResponse)

ListGrantsRequest generates a "aws/request.Request" representing the client's request for the ListGrants operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListGrants for more information on using the ListGrants API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListGrantsRequest method.
req, resp := client.ListGrantsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListGrants

func (*KMS) ListGrantsWithContext

func (c *KMS) ListGrantsWithContext(ctx aws.Context, input *ListGrantsInput, opts ...request.Option) (*ListGrantsResponse, error)

ListGrantsWithContext is the same as ListGrants with the addition of the ability to pass a context and additional request options.

See ListGrants for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) ListKeyPolicies

func (c *KMS) ListKeyPolicies(input *ListKeyPoliciesInput) (*ListKeyPoliciesOutput, error)

ListKeyPolicies API operation for AWS Key Management Service.

Gets the names of the key policies that are attached to a customer master key (CMK). This operation is designed to get policy names that you can use in a GetKeyPolicy operation. However, the only valid policy name is default. You cannot perform this operation on a CMK in a different AWS account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation ListKeyPolicies for usage and error information.

Returned Error Types:

* NotFoundException
The request was rejected because the specified entity or resource could not
be found.

* InvalidArnException
The request was rejected because a specified ARN, or an ARN in a key policy,
is not valid.

* DependencyTimeoutException
The system timed out while trying to fulfill the request. The request can
be retried.

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

* InvalidStateException
The request was rejected because the state of the specified resource is not
valid for this request.

For more information about how key state affects the use of a CMK, see How
Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html)
in the AWS Key Management Service Developer Guide .

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListKeyPolicies

Example (Shared00)

To list key policies for a customer master key (CMK) The following example lists key policies for the specified CMK.

Code:

svc := kms.New(session.New())
input := &kms.ListKeyPoliciesInput{
    KeyId: aws.String("1234abcd-12ab-34cd-56ef-1234567890ab"),
}

result, err := svc.ListKeyPolicies(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case kms.ErrCodeNotFoundException:
            fmt.Println(kms.ErrCodeNotFoundException, aerr.Error())
        case kms.ErrCodeInvalidArnException:
            fmt.Println(kms.ErrCodeInvalidArnException, aerr.Error())
        case kms.ErrCodeDependencyTimeoutException:
            fmt.Println(kms.ErrCodeDependencyTimeoutException, aerr.Error())
        case kms.ErrCodeInternalException:
            fmt.Println(kms.ErrCodeInternalException, aerr.Error())
        case kms.ErrCodeInvalidStateException:
            fmt.Println(kms.ErrCodeInvalidStateException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*KMS) ListKeyPoliciesPages

func (c *KMS) ListKeyPoliciesPages(input *ListKeyPoliciesInput, fn func(*ListKeyPoliciesOutput, bool) bool) error

ListKeyPoliciesPages iterates over the pages of a ListKeyPolicies operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListKeyPolicies method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListKeyPolicies operation.
pageNum := 0
err := client.ListKeyPoliciesPages(params,
    func(page *kms.ListKeyPoliciesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*KMS) ListKeyPoliciesPagesWithContext

func (c *KMS) ListKeyPoliciesPagesWithContext(ctx aws.Context, input *ListKeyPoliciesInput, fn func(*ListKeyPoliciesOutput, bool) bool, opts ...request.Option) error

ListKeyPoliciesPagesWithContext same as ListKeyPoliciesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) ListKeyPoliciesRequest

func (c *KMS) ListKeyPoliciesRequest(input *ListKeyPoliciesInput) (req *request.Request, output *ListKeyPoliciesOutput)

ListKeyPoliciesRequest generates a "aws/request.Request" representing the client's request for the ListKeyPolicies operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListKeyPolicies for more information on using the ListKeyPolicies API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListKeyPoliciesRequest method.
req, resp := client.ListKeyPoliciesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListKeyPolicies

func (*KMS) ListKeyPoliciesWithContext

func (c *KMS) ListKeyPoliciesWithContext(ctx aws.Context, input *ListKeyPoliciesInput, opts ...request.Option) (*ListKeyPoliciesOutput, error)

ListKeyPoliciesWithContext is the same as ListKeyPolicies with the addition of the ability to pass a context and additional request options.

See ListKeyPolicies for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) ListKeys

func (c *KMS) ListKeys(input *ListKeysInput) (*ListKeysOutput, error)

ListKeys API operation for AWS Key Management Service.

Gets a list of all customer master keys (CMKs) in the caller's AWS account and Region.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation ListKeys for usage and error information.

Returned Error Types:

* DependencyTimeoutException
The system timed out while trying to fulfill the request. The request can
be retried.

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

* InvalidMarkerException
The request was rejected because the marker that specifies where pagination
should next begin is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListKeys

Example (Shared00)

To list customer master keys (CMKs) The following example lists CMKs.

Code:

svc := kms.New(session.New())
input := &kms.ListKeysInput{}

result, err := svc.ListKeys(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case kms.ErrCodeDependencyTimeoutException:
            fmt.Println(kms.ErrCodeDependencyTimeoutException, aerr.Error())
        case kms.ErrCodeInternalException:
            fmt.Println(kms.ErrCodeInternalException, aerr.Error())
        case kms.ErrCodeInvalidMarkerException:
            fmt.Println(kms.ErrCodeInvalidMarkerException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*KMS) ListKeysPages

func (c *KMS) ListKeysPages(input *ListKeysInput, fn func(*ListKeysOutput, bool) bool) error

ListKeysPages iterates over the pages of a ListKeys operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListKeys method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListKeys operation.
pageNum := 0
err := client.ListKeysPages(params,
    func(page *kms.ListKeysOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*KMS) ListKeysPagesWithContext

func (c *KMS) ListKeysPagesWithContext(ctx aws.Context, input *ListKeysInput, fn func(*ListKeysOutput, bool) bool, opts ...request.Option) error

ListKeysPagesWithContext same as ListKeysPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) ListKeysRequest

func (c *KMS) ListKeysRequest(input *ListKeysInput) (req *request.Request, output *ListKeysOutput)

ListKeysRequest generates a "aws/request.Request" representing the client's request for the ListKeys operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListKeys for more information on using the ListKeys API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListKeysRequest method.
req, resp := client.ListKeysRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListKeys

func (*KMS) ListKeysWithContext

func (c *KMS) ListKeysWithContext(ctx aws.Context, input *ListKeysInput, opts ...request.Option) (*ListKeysOutput, error)

ListKeysWithContext is the same as ListKeys with the addition of the ability to pass a context and additional request options.

See ListKeys for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) ListResourceTags

func (c *KMS) ListResourceTags(input *ListResourceTagsInput) (*ListResourceTagsOutput, error)

ListResourceTags API operation for AWS Key Management Service.

Returns a list of all tags for the specified customer master key (CMK).

You cannot perform this operation on a CMK in a different AWS account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation ListResourceTags for usage and error information.

Returned Error Types:

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

* NotFoundException
The request was rejected because the specified entity or resource could not
be found.

* InvalidArnException
The request was rejected because a specified ARN, or an ARN in a key policy,
is not valid.

* InvalidMarkerException
The request was rejected because the marker that specifies where pagination
should next begin is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListResourceTags

Example (Shared00)

To list tags for a customer master key (CMK) The following example lists tags for a CMK.

Code:

svc := kms.New(session.New())
input := &kms.ListResourceTagsInput{
    KeyId: aws.String("1234abcd-12ab-34cd-56ef-1234567890ab"),
}

result, err := svc.ListResourceTags(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case kms.ErrCodeInternalException:
            fmt.Println(kms.ErrCodeInternalException, aerr.Error())
        case kms.ErrCodeNotFoundException:
            fmt.Println(kms.ErrCodeNotFoundException, aerr.Error())
        case kms.ErrCodeInvalidArnException:
            fmt.Println(kms.ErrCodeInvalidArnException, aerr.Error())
        case kms.ErrCodeInvalidMarkerException:
            fmt.Println(kms.ErrCodeInvalidMarkerException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*KMS) ListResourceTagsRequest

func (c *KMS) ListResourceTagsRequest(input *ListResourceTagsInput) (req *request.Request, output *ListResourceTagsOutput)

ListResourceTagsRequest generates a "aws/request.Request" representing the client's request for the ListResourceTags operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListResourceTags for more information on using the ListResourceTags API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListResourceTagsRequest method.
req, resp := client.ListResourceTagsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListResourceTags

func (*KMS) ListResourceTagsWithContext

func (c *KMS) ListResourceTagsWithContext(ctx aws.Context, input *ListResourceTagsInput, opts ...request.Option) (*ListResourceTagsOutput, error)

ListResourceTagsWithContext is the same as ListResourceTags with the addition of the ability to pass a context and additional request options.

See ListResourceTags for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) ListRetirableGrants

func (c *KMS) ListRetirableGrants(input *ListRetirableGrantsInput) (*ListGrantsResponse, error)

ListRetirableGrants API operation for AWS Key Management Service.

Returns a list of all grants for which the grant's RetiringPrincipal matches the one specified.

A typical use is to list all grants that you are able to retire. To retire a grant, use RetireGrant.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation ListRetirableGrants for usage and error information.

Returned Error Types:

* DependencyTimeoutException
The system timed out while trying to fulfill the request. The request can
be retried.

* InvalidMarkerException
The request was rejected because the marker that specifies where pagination
should next begin is not valid.

* InvalidArnException
The request was rejected because a specified ARN, or an ARN in a key policy,
is not valid.

* NotFoundException
The request was rejected because the specified entity or resource could not
be found.

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListRetirableGrants

Example (Shared00)

To list grants that the specified principal can retire The following example lists the grants that the specified principal (identity) can retire.

Code:

svc := kms.New(session.New())
input := &kms.ListRetirableGrantsInput{
    RetiringPrincipal: aws.String("arn:aws:iam::111122223333:role/ExampleRole"),
}

result, err := svc.ListRetirableGrants(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case kms.ErrCodeDependencyTimeoutException:
            fmt.Println(kms.ErrCodeDependencyTimeoutException, aerr.Error())
        case kms.ErrCodeInvalidMarkerException:
            fmt.Println(kms.ErrCodeInvalidMarkerException, aerr.Error())
        case kms.ErrCodeInvalidArnException:
            fmt.Println(kms.ErrCodeInvalidArnException, aerr.Error())
        case kms.ErrCodeNotFoundException:
            fmt.Println(kms.ErrCodeNotFoundException, aerr.Error())
        case kms.ErrCodeInternalException:
            fmt.Println(kms.ErrCodeInternalException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*KMS) ListRetirableGrantsRequest

func (c *KMS) ListRetirableGrantsRequest(input *ListRetirableGrantsInput) (req *request.Request, output *ListGrantsResponse)

ListRetirableGrantsRequest generates a "aws/request.Request" representing the client's request for the ListRetirableGrants operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListRetirableGrants for more information on using the ListRetirableGrants API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListRetirableGrantsRequest method.
req, resp := client.ListRetirableGrantsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ListRetirableGrants

func (*KMS) ListRetirableGrantsWithContext

func (c *KMS) ListRetirableGrantsWithContext(ctx aws.Context, input *ListRetirableGrantsInput, opts ...request.Option) (*ListGrantsResponse, error)

ListRetirableGrantsWithContext is the same as ListRetirableGrants with the addition of the ability to pass a context and additional request options.

See ListRetirableGrants for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) PutKeyPolicy

func (c *KMS) PutKeyPolicy(input *PutKeyPolicyInput) (*PutKeyPolicyOutput, error)

PutKeyPolicy API operation for AWS Key Management Service.

Attaches a key policy to the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.

For more information about key policies, see Key Policies (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html) in the AWS Key Management Service Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation PutKeyPolicy for usage and error information.

Returned Error Types:

* NotFoundException
The request was rejected because the specified entity or resource could not
be found.

* InvalidArnException
The request was rejected because a specified ARN, or an ARN in a key policy,
is not valid.

* MalformedPolicyDocumentException
The request was rejected because the specified policy is not syntactically
or semantically correct.

* DependencyTimeoutException
The system timed out while trying to fulfill the request. The request can
be retried.

* UnsupportedOperationException
The request was rejected because a specified parameter is not supported or
a specified resource is not valid for this operation.

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

* LimitExceededException
The request was rejected because a quota was exceeded. For more information,
see Quotas (https://docs.aws.amazon.com/kms/latest/developerguide/limits.html)
in the AWS Key Management Service Developer Guide.

* InvalidStateException
The request was rejected because the state of the specified resource is not
valid for this request.

For more information about how key state affects the use of a CMK, see How
Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html)
in the AWS Key Management Service Developer Guide .

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/PutKeyPolicy

Example (Shared00)

To attach a key policy to a customer master key (CMK) The following example attaches a key policy to the specified CMK.

Code:

svc := kms.New(session.New())
input := &kms.PutKeyPolicyInput{
    KeyId:      aws.String("1234abcd-12ab-34cd-56ef-1234567890ab"),
    Policy:     aws.String("{\n    \"Version\": \"2012-10-17\",\n    \"Id\": \"custom-policy-2016-12-07\",\n    \"Statement\": [\n        {\n            \"Sid\": \"Enable IAM User Permissions\",\n            \"Effect\": \"Allow\",\n            \"Principal\": {\n                \"AWS\": \"arn:aws:iam::111122223333:root\"\n            },\n            \"Action\": \"kms:*\",\n            \"Resource\": \"*\"\n        },\n        {\n            \"Sid\": \"Allow access for Key Administrators\",\n            \"Effect\": \"Allow\",\n            \"Principal\": {\n                \"AWS\": [\n                    \"arn:aws:iam::111122223333:user/ExampleAdminUser\",\n                    \"arn:aws:iam::111122223333:role/ExampleAdminRole\"\n                ]\n            },\n            \"Action\": [\n                \"kms:Create*\",\n                \"kms:Describe*\",\n                \"kms:Enable*\",\n                \"kms:List*\",\n                \"kms:Put*\",\n                \"kms:Update*\",\n                \"kms:Revoke*\",\n                \"kms:Disable*\",\n                \"kms:Get*\",\n                \"kms:Delete*\",\n                \"kms:ScheduleKeyDeletion\",\n                \"kms:CancelKeyDeletion\"\n            ],\n            \"Resource\": \"*\"\n        },\n        {\n            \"Sid\": \"Allow use of the key\",\n            \"Effect\": \"Allow\",\n            \"Principal\": {\n                \"AWS\": \"arn:aws:iam::111122223333:role/ExamplePowerUserRole\"\n            },\n            \"Action\": [\n                \"kms:Encrypt\",\n                \"kms:Decrypt\",\n                \"kms:ReEncrypt*\",\n                \"kms:GenerateDataKey*\",\n                \"kms:DescribeKey\"\n            ],\n            \"Resource\": \"*\"\n        },\n        {\n            \"Sid\": \"Allow attachment of persistent resources\",\n            \"Effect\": \"Allow\",\n            \"Principal\": {\n                \"AWS\": \"arn:aws:iam::111122223333:role/ExamplePowerUserRole\"\n            },\n            \"Action\": [\n                \"kms:CreateGrant\",\n                \"kms:ListGrants\",\n                \"kms:RevokeGrant\"\n            ],\n            \"Resource\": \"*\",\n            \"Condition\": {\n                \"Bool\": {\n                    \"kms:GrantIsForAWSResource\": \"true\"\n                }\n            }\n        }\n    ]\n}\n"),
    PolicyName: aws.String("default"),
}

result, err := svc.PutKeyPolicy(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case kms.ErrCodeNotFoundException:
            fmt.Println(kms.ErrCodeNotFoundException, aerr.Error())
        case kms.ErrCodeInvalidArnException:
            fmt.Println(kms.ErrCodeInvalidArnException, aerr.Error())
        case kms.ErrCodeMalformedPolicyDocumentException:
            fmt.Println(kms.ErrCodeMalformedPolicyDocumentException, aerr.Error())
        case kms.ErrCodeDependencyTimeoutException:
            fmt.Println(kms.ErrCodeDependencyTimeoutException, aerr.Error())
        case kms.ErrCodeUnsupportedOperationException:
            fmt.Println(kms.ErrCodeUnsupportedOperationException, aerr.Error())
        case kms.ErrCodeInternalException:
            fmt.Println(kms.ErrCodeInternalException, aerr.Error())
        case kms.ErrCodeLimitExceededException:
            fmt.Println(kms.ErrCodeLimitExceededException, aerr.Error())
        case kms.ErrCodeInvalidStateException:
            fmt.Println(kms.ErrCodeInvalidStateException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*KMS) PutKeyPolicyRequest

func (c *KMS) PutKeyPolicyRequest(input *PutKeyPolicyInput) (req *request.Request, output *PutKeyPolicyOutput)

PutKeyPolicyRequest generates a "aws/request.Request" representing the client's request for the PutKeyPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutKeyPolicy for more information on using the PutKeyPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutKeyPolicyRequest method.
req, resp := client.PutKeyPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/PutKeyPolicy

func (*KMS) PutKeyPolicyWithContext

func (c *KMS) PutKeyPolicyWithContext(ctx aws.Context, input *PutKeyPolicyInput, opts ...request.Option) (*PutKeyPolicyOutput, error)

PutKeyPolicyWithContext is the same as PutKeyPolicy with the addition of the ability to pass a context and additional request options.

See PutKeyPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) ReEncrypt

func (c *KMS) ReEncrypt(input *ReEncryptInput) (*ReEncryptOutput, error)

ReEncrypt API operation for AWS Key Management Service.

Decrypts ciphertext and then reencrypts it entirely within AWS KMS. You can use this operation to change the customer master key (CMK) under which data is encrypted, such as when you manually rotate (https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotate-keys-manually) a CMK or change the CMK that protects a ciphertext. You can also use it to reencrypt ciphertext under the same CMK, such as to change the encryption context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context) of a ciphertext.

The ReEncrypt operation can decrypt ciphertext that was encrypted by using an AWS KMS CMK in an AWS KMS operation, such as Encrypt or GenerateDataKey. It can also decrypt ciphertext that was encrypted by using the public key of an asymmetric CMK (https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html#asymmetric-cmks) outside of AWS KMS. However, it cannot decrypt ciphertext produced by other libraries, such as the AWS Encryption SDK (https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/) or Amazon S3 client-side encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingClientSideEncryption.html). These libraries return a ciphertext format that is incompatible with AWS KMS.

When you use the ReEncrypt operation, you need to provide information for the decrypt operation and the subsequent encrypt operation.

* If your ciphertext was encrypted under an asymmetric CMK, you must identify
the source CMK, that is, the CMK that encrypted the ciphertext. You must
also supply the encryption algorithm that was used. This information is
required to decrypt the data.

* It is optional, but you can specify a source CMK even when the ciphertext
was encrypted under a symmetric CMK. This ensures that the ciphertext
is decrypted only by using a particular CMK. If the CMK that you specify
cannot decrypt the ciphertext, the ReEncrypt operation fails.

* To reencrypt the data, you must specify the destination CMK, that is,
the CMK that re-encrypts the data after it is decrypted. You can select
a symmetric or asymmetric CMK. If the destination CMK is an asymmetric
CMK, you must also provide the encryption algorithm. The algorithm that
you choose must be compatible with the CMK. When you use an asymmetric
CMK to encrypt or reencrypt data, be sure to record the CMK and encryption
algorithm that you choose. You will be required to provide the same CMK
and encryption algorithm when you decrypt the data. If the CMK and algorithm
do not match the values used to encrypt the data, the decrypt operation
fails. You are not required to supply the CMK ID and encryption algorithm
when you decrypt with symmetric CMKs because AWS KMS stores this information
in the ciphertext blob. AWS KMS cannot store metadata in ciphertext generated
with asymmetric keys. The standard format for asymmetric key ciphertext
does not include configurable fields.

Unlike other AWS KMS API operations, ReEncrypt callers must have two permissions:

* kms:ReEncryptFrom permission on the source CMK

* kms:ReEncryptTo permission on the destination CMK

To permit reencryption from or to a CMK, include the "kms:ReEncrypt*" permission in your key policy (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html). This permission is automatically included in the key policy when you use the console to create a CMK. But you must include it manually when you create a CMK programmatically or when you use the PutKeyPolicy operation to set a key policy.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the AWS Key Management Service Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation ReEncrypt for usage and error information.

Returned Error Types:

* NotFoundException
The request was rejected because the specified entity or resource could not
be found.

* DisabledException
The request was rejected because the specified CMK is not enabled.

* InvalidCiphertextException
From the Decrypt or ReEncrypt operation, the request was rejected because
the specified ciphertext, or additional authenticated data incorporated into
the ciphertext, such as the encryption context, is corrupted, missing, or
otherwise invalid.

From the ImportKeyMaterial operation, the request was rejected because AWS
KMS could not decrypt the encrypted (wrapped) key material.

* KeyUnavailableException
The request was rejected because the specified CMK was not available. You
can retry the request.

* IncorrectKeyException
The request was rejected because the specified CMK cannot decrypt the data.
The KeyId in a Decrypt request and the SourceKeyId in a ReEncrypt request
must identify the same CMK that was used to encrypt the ciphertext.

* DependencyTimeoutException
The system timed out while trying to fulfill the request. The request can
be retried.

* InvalidKeyUsageException
The request was rejected for one of the following reasons:

   * The KeyUsage value of the CMK 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 CMK (CustomerMasterKeySpec).

For encrypting, decrypting, re-encrypting, and generating data keys, the
KeyUsage must be ENCRYPT_DECRYPT. For signing and verifying, the KeyUsage
must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation.

To find the encryption or signing algorithms supported for a particular CMK,
use the DescribeKey operation.

* InvalidGrantTokenException
The request was rejected because the specified grant token is not valid.

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

* InvalidStateException
The request was rejected because the state of the specified resource is not
valid for this request.

For more information about how key state affects the use of a CMK, see How
Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html)
in the AWS Key Management Service Developer Guide .

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ReEncrypt

Example (Shared00)

To reencrypt data The following example reencrypts data with the specified CMK.

Code:

svc := kms.New(session.New())
input := &kms.ReEncryptInput{
    CiphertextBlob:   []byte("<binary data>"),
    DestinationKeyId: aws.String("0987dcba-09fe-87dc-65ba-ab0987654321"),
}

result, err := svc.ReEncrypt(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case kms.ErrCodeNotFoundException:
            fmt.Println(kms.ErrCodeNotFoundException, aerr.Error())
        case kms.ErrCodeDisabledException:
            fmt.Println(kms.ErrCodeDisabledException, aerr.Error())
        case kms.ErrCodeInvalidCiphertextException:
            fmt.Println(kms.ErrCodeInvalidCiphertextException, aerr.Error())
        case kms.ErrCodeKeyUnavailableException:
            fmt.Println(kms.ErrCodeKeyUnavailableException, aerr.Error())
        case kms.ErrCodeIncorrectKeyException:
            fmt.Println(kms.ErrCodeIncorrectKeyException, aerr.Error())
        case kms.ErrCodeDependencyTimeoutException:
            fmt.Println(kms.ErrCodeDependencyTimeoutException, aerr.Error())
        case kms.ErrCodeInvalidKeyUsageException:
            fmt.Println(kms.ErrCodeInvalidKeyUsageException, aerr.Error())
        case kms.ErrCodeInvalidGrantTokenException:
            fmt.Println(kms.ErrCodeInvalidGrantTokenException, aerr.Error())
        case kms.ErrCodeInternalException:
            fmt.Println(kms.ErrCodeInternalException, aerr.Error())
        case kms.ErrCodeInvalidStateException:
            fmt.Println(kms.ErrCodeInvalidStateException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*KMS) ReEncryptRequest

func (c *KMS) ReEncryptRequest(input *ReEncryptInput) (req *request.Request, output *ReEncryptOutput)

ReEncryptRequest generates a "aws/request.Request" representing the client's request for the ReEncrypt operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ReEncrypt for more information on using the ReEncrypt API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ReEncryptRequest method.
req, resp := client.ReEncryptRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ReEncrypt

func (*KMS) ReEncryptWithContext

func (c *KMS) ReEncryptWithContext(ctx aws.Context, input *ReEncryptInput, opts ...request.Option) (*ReEncryptOutput, error)

ReEncryptWithContext is the same as ReEncrypt with the addition of the ability to pass a context and additional request options.

See ReEncrypt for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) RetireGrant

func (c *KMS) RetireGrant(input *RetireGrantInput) (*RetireGrantOutput, error)

RetireGrant API operation for AWS Key Management Service.

Retires a grant. To clean up, you can retire a grant when you're done using it. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API:

* The AWS account (root user) under which the grant was created

* The RetiringPrincipal, if present in the grant

* The GranteePrincipal, if RetireGrant is an operation specified in the
grant

You must identify the grant to retire by its grant token or by a combination of the grant ID and the Amazon Resource Name (ARN) of the customer master key (CMK). A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. The CreateGrant operation returns both.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation RetireGrant for usage and error information.

Returned Error Types:

* InvalidArnException
The request was rejected because a specified ARN, or an ARN in a key policy,
is not valid.

* InvalidGrantTokenException
The request was rejected because the specified grant token is not valid.

* InvalidGrantIdException
The request was rejected because the specified GrantId is not valid.

* NotFoundException
The request was rejected because the specified entity or resource could not
be found.

* DependencyTimeoutException
The system timed out while trying to fulfill the request. The request can
be retried.

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

* InvalidStateException
The request was rejected because the state of the specified resource is not
valid for this request.

For more information about how key state affects the use of a CMK, see How
Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html)
in the AWS Key Management Service Developer Guide .

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/RetireGrant

Example (Shared00)

To retire a grant The following example retires a grant.

Code:

svc := kms.New(session.New())
input := &kms.RetireGrantInput{
    GrantId: aws.String("0c237476b39f8bc44e45212e08498fbe3151305030726c0590dd8d3e9f3d6a60"),
    KeyId:   aws.String("arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab"),
}

result, err := svc.RetireGrant(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case kms.ErrCodeInvalidArnException:
            fmt.Println(kms.ErrCodeInvalidArnException, aerr.Error())
        case kms.ErrCodeInvalidGrantTokenException:
            fmt.Println(kms.ErrCodeInvalidGrantTokenException, aerr.Error())
        case kms.ErrCodeInvalidGrantIdException:
            fmt.Println(kms.ErrCodeInvalidGrantIdException, aerr.Error())
        case kms.ErrCodeNotFoundException:
            fmt.Println(kms.ErrCodeNotFoundException, aerr.Error())
        case kms.ErrCodeDependencyTimeoutException:
            fmt.Println(kms.ErrCodeDependencyTimeoutException, aerr.Error())
        case kms.ErrCodeInternalException:
            fmt.Println(kms.ErrCodeInternalException, aerr.Error())
        case kms.ErrCodeInvalidStateException:
            fmt.Println(kms.ErrCodeInvalidStateException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*KMS) RetireGrantRequest

func (c *KMS) RetireGrantRequest(input *RetireGrantInput) (req *request.Request, output *RetireGrantOutput)

RetireGrantRequest generates a "aws/request.Request" representing the client's request for the RetireGrant operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RetireGrant for more information on using the RetireGrant API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RetireGrantRequest method.
req, resp := client.RetireGrantRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/RetireGrant

func (*KMS) RetireGrantWithContext

func (c *KMS) RetireGrantWithContext(ctx aws.Context, input *RetireGrantInput, opts ...request.Option) (*RetireGrantOutput, error)

RetireGrantWithContext is the same as RetireGrant with the addition of the ability to pass a context and additional request options.

See RetireGrant for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) RevokeGrant

func (c *KMS) RevokeGrant(input *RevokeGrantInput) (*RevokeGrantOutput, error)

RevokeGrant API operation for AWS Key Management Service.

Revokes the specified grant for the specified customer master key (CMK). You can revoke a grant to actively deny operations that depend on it.

To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation RevokeGrant for usage and error information.

Returned Error Types:

* NotFoundException
The request was rejected because the specified entity or resource could not
be found.

* DependencyTimeoutException
The system timed out while trying to fulfill the request. The request can
be retried.

* InvalidArnException
The request was rejected because a specified ARN, or an ARN in a key policy,
is not valid.

* InvalidGrantIdException
The request was rejected because the specified GrantId is not valid.

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

* InvalidStateException
The request was rejected because the state of the specified resource is not
valid for this request.

For more information about how key state affects the use of a CMK, see How
Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html)
in the AWS Key Management Service Developer Guide .

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/RevokeGrant

Example (Shared00)

To revoke a grant The following example revokes a grant.

Code:

svc := kms.New(session.New())
input := &kms.RevokeGrantInput{
    GrantId: aws.String("0c237476b39f8bc44e45212e08498fbe3151305030726c0590dd8d3e9f3d6a60"),
    KeyId:   aws.String("1234abcd-12ab-34cd-56ef-1234567890ab"),
}

result, err := svc.RevokeGrant(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case kms.ErrCodeNotFoundException:
            fmt.Println(kms.ErrCodeNotFoundException, aerr.Error())
        case kms.ErrCodeDependencyTimeoutException:
            fmt.Println(kms.ErrCodeDependencyTimeoutException, aerr.Error())
        case kms.ErrCodeInvalidArnException:
            fmt.Println(kms.ErrCodeInvalidArnException, aerr.Error())
        case kms.ErrCodeInvalidGrantIdException:
            fmt.Println(kms.ErrCodeInvalidGrantIdException, aerr.Error())
        case kms.ErrCodeInternalException:
            fmt.Println(kms.ErrCodeInternalException, aerr.Error())
        case kms.ErrCodeInvalidStateException:
            fmt.Println(kms.ErrCodeInvalidStateException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*KMS) RevokeGrantRequest

func (c *KMS) RevokeGrantRequest(input *RevokeGrantInput) (req *request.Request, output *RevokeGrantOutput)

RevokeGrantRequest generates a "aws/request.Request" representing the client's request for the RevokeGrant operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RevokeGrant for more information on using the RevokeGrant API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RevokeGrantRequest method.
req, resp := client.RevokeGrantRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/RevokeGrant

func (*KMS) RevokeGrantWithContext

func (c *KMS) RevokeGrantWithContext(ctx aws.Context, input *RevokeGrantInput, opts ...request.Option) (*RevokeGrantOutput, error)

RevokeGrantWithContext is the same as RevokeGrant with the addition of the ability to pass a context and additional request options.

See RevokeGrant for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) ScheduleKeyDeletion

func (c *KMS) ScheduleKeyDeletion(input *ScheduleKeyDeletionInput) (*ScheduleKeyDeletionOutput, error)

ScheduleKeyDeletion API operation for AWS Key Management Service.

Schedules the deletion of a customer master key (CMK). You may provide a waiting period, specified in days, before deletion occurs. If you do not provide a waiting period, the default period of 30 days is used. When this operation is successful, the key state of the CMK changes to PendingDeletion. Before the waiting period ends, you can use CancelKeyDeletion to cancel the deletion of the CMK. After the waiting period ends, AWS KMS deletes the CMK and all AWS KMS data associated with it, including all aliases that refer to it.

Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is unrecoverable. To prevent the use of a CMK without deleting it, use DisableKey.

If you schedule deletion of a CMK from a custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html), when the waiting period expires, ScheduleKeyDeletion deletes the CMK from AWS KMS. Then AWS KMS makes a best effort to delete the key material from the associated AWS CloudHSM cluster. However, you might need to manually delete the orphaned key material (https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-orphaned-key) from the cluster and its backups.

You cannot perform this operation on a CMK in a different AWS account.

For more information about scheduling a CMK for deletion, see Deleting Customer Master Keys (https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) in the AWS Key Management Service Developer Guide.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the AWS Key Management Service Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation ScheduleKeyDeletion for usage and error information.

Returned Error Types:

* NotFoundException
The request was rejected because the specified entity or resource could not
be found.

* InvalidArnException
The request was rejected because a specified ARN, or an ARN in a key policy,
is not valid.

* DependencyTimeoutException
The system timed out while trying to fulfill the request. The request can
be retried.

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

* InvalidStateException
The request was rejected because the state of the specified resource is not
valid for this request.

For more information about how key state affects the use of a CMK, see How
Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html)
in the AWS Key Management Service Developer Guide .

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ScheduleKeyDeletion

Example (Shared00)

To schedule a customer master key (CMK) for deletion The following example schedules the specified CMK for deletion.

Code:

svc := kms.New(session.New())
input := &kms.ScheduleKeyDeletionInput{
    KeyId:               aws.String("1234abcd-12ab-34cd-56ef-1234567890ab"),
    PendingWindowInDays: aws.Int64(7),
}

result, err := svc.ScheduleKeyDeletion(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case kms.ErrCodeNotFoundException:
            fmt.Println(kms.ErrCodeNotFoundException, aerr.Error())
        case kms.ErrCodeInvalidArnException:
            fmt.Println(kms.ErrCodeInvalidArnException, aerr.Error())
        case kms.ErrCodeDependencyTimeoutException:
            fmt.Println(kms.ErrCodeDependencyTimeoutException, aerr.Error())
        case kms.ErrCodeInternalException:
            fmt.Println(kms.ErrCodeInternalException, aerr.Error())
        case kms.ErrCodeInvalidStateException:
            fmt.Println(kms.ErrCodeInvalidStateException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*KMS) ScheduleKeyDeletionRequest

func (c *KMS) ScheduleKeyDeletionRequest(input *ScheduleKeyDeletionInput) (req *request.Request, output *ScheduleKeyDeletionOutput)

ScheduleKeyDeletionRequest generates a "aws/request.Request" representing the client's request for the ScheduleKeyDeletion operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ScheduleKeyDeletion for more information on using the ScheduleKeyDeletion API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ScheduleKeyDeletionRequest method.
req, resp := client.ScheduleKeyDeletionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/ScheduleKeyDeletion

func (*KMS) ScheduleKeyDeletionWithContext

func (c *KMS) ScheduleKeyDeletionWithContext(ctx aws.Context, input *ScheduleKeyDeletionInput, opts ...request.Option) (*ScheduleKeyDeletionOutput, error)

ScheduleKeyDeletionWithContext is the same as ScheduleKeyDeletion with the addition of the ability to pass a context and additional request options.

See ScheduleKeyDeletion for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) Sign

func (c *KMS) Sign(input *SignInput) (*SignOutput, error)

Sign API operation for AWS Key Management Service.

Creates a digital signature (https://en.wikipedia.org/wiki/Digital_signature) for a message or message digest by using the private key in an asymmetric CMK. To verify the signature, use the Verify operation, or use the public key in the same asymmetric CMK outside of AWS KMS. For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) in the AWS Key Management Service Developer Guide.

Digital signatures are generated and verified by using asymmetric key pair, such as an RSA or ECC pair that is represented by an asymmetric customer master key (CMK). The key owner (or an authorized user) uses their private key to sign a message. Anyone with the public key can verify that the message was signed with that particular private key and that the message hasn't changed since it was signed.

To use the Sign operation, provide the following information:

* Use the KeyId parameter to identify an asymmetric CMK with a KeyUsage
value of SIGN_VERIFY. To get the KeyUsage value of a CMK, use the DescribeKey
operation. The caller must have kms:Sign permission on the CMK.

* Use the Message parameter to specify the message or message digest to
sign. You can submit messages of up to 4096 bytes. To sign a larger message,
generate a hash digest of the message, and then provide the hash digest
in the Message parameter. To indicate whether the message is a full message
or a digest, use the MessageType parameter.

* Choose a signing algorithm that is compatible with the CMK.

When signing a message, be sure to record the CMK and the signing algorithm. This information is required to verify the signature.

To verify the signature that this operation generates, use the Verify operation. Or use the GetPublicKey operation to download the public key and then use the public key to verify the signature outside of AWS KMS.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the AWS Key Management Service Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation Sign for usage and error information.

Returned Error Types:

* NotFoundException
The request was rejected because the specified entity or resource could not
be found.

* DisabledException
The request was rejected because the specified CMK is not enabled.

* KeyUnavailableException
The request was rejected because the specified CMK was not available. You
can retry the request.

* DependencyTimeoutException
The system timed out while trying to fulfill the request. The request can
be retried.

* InvalidKeyUsageException
The request was rejected for one of the following reasons:

   * The KeyUsage value of the CMK 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 CMK (CustomerMasterKeySpec).

For encrypting, decrypting, re-encrypting, and generating data keys, the
KeyUsage must be ENCRYPT_DECRYPT. For signing and verifying, the KeyUsage
must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation.

To find the encryption or signing algorithms supported for a particular CMK,
use the DescribeKey operation.

* InvalidGrantTokenException
The request was rejected because the specified grant token is not valid.

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

* InvalidStateException
The request was rejected because the state of the specified resource is not
valid for this request.

For more information about how key state affects the use of a CMK, see How
Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html)
in the AWS Key Management Service Developer Guide .

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/Sign

func (*KMS) SignRequest

func (c *KMS) SignRequest(input *SignInput) (req *request.Request, output *SignOutput)

SignRequest generates a "aws/request.Request" representing the client's request for the Sign operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See Sign for more information on using the Sign API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the SignRequest method.
req, resp := client.SignRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/Sign

func (*KMS) SignWithContext

func (c *KMS) SignWithContext(ctx aws.Context, input *SignInput, opts ...request.Option) (*SignOutput, error)

SignWithContext is the same as Sign with the addition of the ability to pass a context and additional request options.

See Sign for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) TagResource

func (c *KMS) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for AWS Key Management Service.

Adds or edits tags for a customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.

Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.

You can only use a tag key once for each CMK. If you use the tag key again, AWS KMS replaces the current tag value with the specified value.

For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html) in the AWS Billing and Cost Management User Guide.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the AWS Key Management Service Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation TagResource for usage and error information.

Returned Error Types:

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

* NotFoundException
The request was rejected because the specified entity or resource could not
be found.

* InvalidArnException
The request was rejected because a specified ARN, or an ARN in a key policy,
is not valid.

* InvalidStateException
The request was rejected because the state of the specified resource is not
valid for this request.

For more information about how key state affects the use of a CMK, see How
Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html)
in the AWS Key Management Service Developer Guide .

* LimitExceededException
The request was rejected because a quota was exceeded. For more information,
see Quotas (https://docs.aws.amazon.com/kms/latest/developerguide/limits.html)
in the AWS Key Management Service Developer Guide.

* TagException
The request was rejected because one or more tags are not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/TagResource

Example (Shared00)

To tag a customer master key (CMK) The following example tags a CMK.

Code:

svc := kms.New(session.New())
input := &kms.TagResourceInput{
    KeyId: aws.String("1234abcd-12ab-34cd-56ef-1234567890ab"),
    Tags: []*kms.Tag{
        {
            TagKey:   aws.String("Purpose"),
            TagValue: aws.String("Test"),
        },
    },
}

result, err := svc.TagResource(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case kms.ErrCodeInternalException:
            fmt.Println(kms.ErrCodeInternalException, aerr.Error())
        case kms.ErrCodeNotFoundException:
            fmt.Println(kms.ErrCodeNotFoundException, aerr.Error())
        case kms.ErrCodeInvalidArnException:
            fmt.Println(kms.ErrCodeInvalidArnException, aerr.Error())
        case kms.ErrCodeInvalidStateException:
            fmt.Println(kms.ErrCodeInvalidStateException, aerr.Error())
        case kms.ErrCodeLimitExceededException:
            fmt.Println(kms.ErrCodeLimitExceededException, aerr.Error())
        case kms.ErrCodeTagException:
            fmt.Println(kms.ErrCodeTagException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*KMS) TagResourceRequest

func (c *KMS) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/TagResource

func (*KMS) TagResourceWithContext

func (c *KMS) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) UntagResource

func (c *KMS) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for AWS Key Management Service.

Removes the specified tags from the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.

To remove a tag, specify the tag key. To change the tag value of an existing tag key, use TagResource.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the AWS Key Management Service Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation UntagResource for usage and error information.

Returned Error Types:

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

* NotFoundException
The request was rejected because the specified entity or resource could not
be found.

* InvalidArnException
The request was rejected because a specified ARN, or an ARN in a key policy,
is not valid.

* InvalidStateException
The request was rejected because the state of the specified resource is not
valid for this request.

For more information about how key state affects the use of a CMK, see How
Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html)
in the AWS Key Management Service Developer Guide .

* TagException
The request was rejected because one or more tags are not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UntagResource

Example (Shared00)

To remove tags from a customer master key (CMK) The following example removes tags from a CMK.

Code:

svc := kms.New(session.New())
input := &kms.UntagResourceInput{
    KeyId: aws.String("1234abcd-12ab-34cd-56ef-1234567890ab"),
    TagKeys: []*string{
        aws.String("Purpose"),
        aws.String("CostCenter"),
    },
}

result, err := svc.UntagResource(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case kms.ErrCodeInternalException:
            fmt.Println(kms.ErrCodeInternalException, aerr.Error())
        case kms.ErrCodeNotFoundException:
            fmt.Println(kms.ErrCodeNotFoundException, aerr.Error())
        case kms.ErrCodeInvalidArnException:
            fmt.Println(kms.ErrCodeInvalidArnException, aerr.Error())
        case kms.ErrCodeInvalidStateException:
            fmt.Println(kms.ErrCodeInvalidStateException, aerr.Error())
        case kms.ErrCodeTagException:
            fmt.Println(kms.ErrCodeTagException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*KMS) UntagResourceRequest

func (c *KMS) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UntagResource

func (*KMS) UntagResourceWithContext

func (c *KMS) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) UpdateAlias

func (c *KMS) UpdateAlias(input *UpdateAliasInput) (*UpdateAliasOutput, error)

UpdateAlias API operation for AWS Key Management Service.

Associates an existing AWS KMS alias with a different customer master key (CMK). Each alias is associated with only one CMK at a time, although a CMK can have multiple aliases. The alias and the CMK must be in the same AWS account and region. You cannot perform this operation on an alias in a different AWS account.

The current and new CMK must be the same type (both symmetric or both asymmetric), and they must have the same key usage (ENCRYPT_DECRYPT or SIGN_VERIFY). This restriction prevents errors in code that uses aliases. If you must assign an alias to a different type of CMK, use DeleteAlias to delete the old alias and CreateAlias to create a new alias.

You cannot use UpdateAlias to change an alias name. To change an alias name, use DeleteAlias to delete the old alias and CreateAlias to create a new alias.

Because an alias is not a property of a CMK, you can create, update, and delete the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs in the account, use the ListAliases operation.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the AWS Key Management Service Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation UpdateAlias for usage and error information.

Returned Error Types:

* DependencyTimeoutException
The system timed out while trying to fulfill the request. The request can
be retried.

* NotFoundException
The request was rejected because the specified entity or resource could not
be found.

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

* LimitExceededException
The request was rejected because a quota was exceeded. For more information,
see Quotas (https://docs.aws.amazon.com/kms/latest/developerguide/limits.html)
in the AWS Key Management Service Developer Guide.

* InvalidStateException
The request was rejected because the state of the specified resource is not
valid for this request.

For more information about how key state affects the use of a CMK, see How
Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html)
in the AWS Key Management Service Developer Guide .

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UpdateAlias

Example (Shared00)

To update an alias The following example updates the specified alias to refer to the specified customer master key (CMK).

Code:

svc := kms.New(session.New())
input := &kms.UpdateAliasInput{
    AliasName:   aws.String("alias/ExampleAlias"),
    TargetKeyId: aws.String("1234abcd-12ab-34cd-56ef-1234567890ab"),
}

result, err := svc.UpdateAlias(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case kms.ErrCodeDependencyTimeoutException:
            fmt.Println(kms.ErrCodeDependencyTimeoutException, aerr.Error())
        case kms.ErrCodeNotFoundException:
            fmt.Println(kms.ErrCodeNotFoundException, aerr.Error())
        case kms.ErrCodeInternalException:
            fmt.Println(kms.ErrCodeInternalException, aerr.Error())
        case kms.ErrCodeLimitExceededException:
            fmt.Println(kms.ErrCodeLimitExceededException, aerr.Error())
        case kms.ErrCodeInvalidStateException:
            fmt.Println(kms.ErrCodeInvalidStateException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*KMS) UpdateAliasRequest

func (c *KMS) UpdateAliasRequest(input *UpdateAliasInput) (req *request.Request, output *UpdateAliasOutput)

UpdateAliasRequest generates a "aws/request.Request" representing the client's request for the UpdateAlias operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateAlias for more information on using the UpdateAlias API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateAliasRequest method.
req, resp := client.UpdateAliasRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UpdateAlias

func (*KMS) UpdateAliasWithContext

func (c *KMS) UpdateAliasWithContext(ctx aws.Context, input *UpdateAliasInput, opts ...request.Option) (*UpdateAliasOutput, error)

UpdateAliasWithContext is the same as UpdateAlias with the addition of the ability to pass a context and additional request options.

See UpdateAlias for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) UpdateCustomKeyStore

func (c *KMS) UpdateCustomKeyStore(input *UpdateCustomKeyStoreInput) (*UpdateCustomKeyStoreOutput, error)

UpdateCustomKeyStore API operation for AWS Key Management Service.

Changes the properties of a custom key store. Use the CustomKeyStoreId parameter to identify the custom key store you want to edit. Use the remaining parameters to change the properties of the custom key store.

You can only update a custom key store that is disconnected. To disconnect the custom key store, use DisconnectCustomKeyStore. To reconnect the custom key store after the update completes, use ConnectCustomKeyStore. To find the connection state of a custom key store, use the DescribeCustomKeyStores operation.

Use the parameters of UpdateCustomKeyStore to edit your keystore settings.

* Use the NewCustomKeyStoreName parameter to change the friendly name
of the custom key store to the value that you specify.

* Use the KeyStorePassword parameter tell AWS KMS the current password
of the kmsuser crypto user (CU) (https://docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-kmsuser)
in the associated AWS CloudHSM cluster. You can use this parameter to
fix connection failures (https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-password)
that occur when AWS KMS cannot log into the associated cluster because
the kmsuser password has changed. This value does not change the password
in the AWS CloudHSM cluster.

* Use the CloudHsmClusterId parameter to associate the custom key store
with a different, but related, AWS CloudHSM cluster. You can use this
parameter to repair a custom key store if its AWS CloudHSM cluster becomes
corrupted or is deleted, or when you need to create or restore a cluster
from a backup.

If the operation succeeds, it returns a JSON object with no properties.

This operation is part of the Custom Key Store feature (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html) feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation UpdateCustomKeyStore for usage and error information.

Returned Error Types:

* CustomKeyStoreNotFoundException
The request was rejected because AWS KMS cannot find a custom key store with
the specified key store name or ID.

* CustomKeyStoreNameInUseException
The request was rejected because the specified custom key store name is already
assigned to another custom key store in the account. Try again with a custom
key store name that is unique in the account.

* CloudHsmClusterNotFoundException
The request was rejected because AWS KMS cannot find the AWS CloudHSM cluster
with the specified cluster ID. Retry the request with a different cluster
ID.

* CloudHsmClusterNotRelatedException
The request was rejected because the specified AWS CloudHSM cluster has a
different cluster certificate than the original cluster. You cannot use the
operation to specify an unrelated cluster.

Specify a cluster that shares a backup history with the original cluster.
This includes clusters that were created from a backup of the current cluster,
and clusters that were created from the same backup that produced the current
cluster.

Clusters that share a backup history have the same cluster certificate. To
view the cluster certificate of a cluster, use the DescribeClusters (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html)
operation.

* CustomKeyStoreInvalidStateException
The request was rejected because of the ConnectionState of the custom key
store. To get the ConnectionState of a custom key store, use the DescribeCustomKeyStores
operation.

This exception is thrown under the following conditions:

   * You requested the CreateKey or GenerateRandom operation in a custom
   key store that is not connected. These operations are valid only when
   the custom key store ConnectionState is CONNECTED.

   * You requested the UpdateCustomKeyStore or DeleteCustomKeyStore operation
   on a custom key store that is not disconnected. This operation is valid
   only when the custom key store ConnectionState is DISCONNECTED.

   * You requested the ConnectCustomKeyStore operation on a custom key store
   with a ConnectionState of DISCONNECTING or FAILED. This operation is valid
   for all other ConnectionState values.

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

* CloudHsmClusterNotActiveException
The request was rejected because the AWS CloudHSM cluster that is associated
with the custom key store is not active. Initialize and activate the cluster
and try the command again. For detailed instructions, see Getting Started
(https://docs.aws.amazon.com/cloudhsm/latest/userguide/getting-started.html)
in the AWS CloudHSM User Guide.

* CloudHsmClusterInvalidConfigurationException
The request was rejected because the associated AWS CloudHSM cluster did
not meet the configuration requirements for a custom key store.

   * The cluster must be configured with private subnets in at least two
   different Availability Zones in the Region.

   * The security group for the cluster (https://docs.aws.amazon.com/cloudhsm/latest/userguide/configure-sg.html)
   (cloudhsm-cluster-<cluster-id>-sg) must include inbound rules and outbound
   rules that allow TCP traffic on ports 2223-2225. The Source in the inbound
   rules and the Destination in the outbound rules must match the security
   group ID. These rules are set by default when you create the cluster.
   Do not delete or change them. To get information about a particular security
   group, use the DescribeSecurityGroups (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSecurityGroups.html)
   operation.

   * The cluster must contain at least as many HSMs as the operation requires.
   To add HSMs, use the AWS CloudHSM CreateHsm (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_CreateHsm.html)
   operation. For the CreateCustomKeyStore, UpdateCustomKeyStore, and CreateKey
   operations, the AWS CloudHSM cluster must have at least two active HSMs,
   each in a different Availability Zone. For the ConnectCustomKeyStore operation,
   the AWS CloudHSM must contain at least one active HSM.

For information about the requirements for an AWS CloudHSM cluster that is
associated with a custom key store, see Assemble the Prerequisites (https://docs.aws.amazon.com/kms/latest/developerguide/create-keystore.html#before-keystore)
in the AWS Key Management Service Developer Guide. For information about
creating a private subnet for an AWS CloudHSM cluster, see Create a Private
Subnet (https://docs.aws.amazon.com/cloudhsm/latest/userguide/create-subnets.html)
in the AWS CloudHSM User Guide. For information about cluster security groups,
see Configure a Default Security Group (https://docs.aws.amazon.com/cloudhsm/latest/userguide/configure-sg.html)
in the AWS CloudHSM User Guide .

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UpdateCustomKeyStore

func (*KMS) UpdateCustomKeyStoreRequest

func (c *KMS) UpdateCustomKeyStoreRequest(input *UpdateCustomKeyStoreInput) (req *request.Request, output *UpdateCustomKeyStoreOutput)

UpdateCustomKeyStoreRequest generates a "aws/request.Request" representing the client's request for the UpdateCustomKeyStore operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateCustomKeyStore for more information on using the UpdateCustomKeyStore API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateCustomKeyStoreRequest method.
req, resp := client.UpdateCustomKeyStoreRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UpdateCustomKeyStore

func (*KMS) UpdateCustomKeyStoreWithContext

func (c *KMS) UpdateCustomKeyStoreWithContext(ctx aws.Context, input *UpdateCustomKeyStoreInput, opts ...request.Option) (*UpdateCustomKeyStoreOutput, error)

UpdateCustomKeyStoreWithContext is the same as UpdateCustomKeyStore with the addition of the ability to pass a context and additional request options.

See UpdateCustomKeyStore for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) UpdateKeyDescription

func (c *KMS) UpdateKeyDescription(input *UpdateKeyDescriptionInput) (*UpdateKeyDescriptionOutput, error)

UpdateKeyDescription API operation for AWS Key Management Service.

Updates the description of a customer master key (CMK). To see the description of a CMK, use DescribeKey.

You cannot perform this operation on a CMK in a different AWS account.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the AWS Key Management Service Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation UpdateKeyDescription for usage and error information.

Returned Error Types:

* NotFoundException
The request was rejected because the specified entity or resource could not
be found.

* InvalidArnException
The request was rejected because a specified ARN, or an ARN in a key policy,
is not valid.

* DependencyTimeoutException
The system timed out while trying to fulfill the request. The request can
be retried.

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

* InvalidStateException
The request was rejected because the state of the specified resource is not
valid for this request.

For more information about how key state affects the use of a CMK, see How
Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html)
in the AWS Key Management Service Developer Guide .

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UpdateKeyDescription

Example (Shared00)

To update the description of a customer master key (CMK) The following example updates the description of the specified CMK.

Code:

svc := kms.New(session.New())
input := &kms.UpdateKeyDescriptionInput{
    Description: aws.String("Example description that indicates the intended use of this CMK."),
    KeyId:       aws.String("1234abcd-12ab-34cd-56ef-1234567890ab"),
}

result, err := svc.UpdateKeyDescription(input)
if err != nil {
    if aerr, ok := err.(awserr.Error); ok {
        switch aerr.Code() {
        case kms.ErrCodeNotFoundException:
            fmt.Println(kms.ErrCodeNotFoundException, aerr.Error())
        case kms.ErrCodeInvalidArnException:
            fmt.Println(kms.ErrCodeInvalidArnException, aerr.Error())
        case kms.ErrCodeDependencyTimeoutException:
            fmt.Println(kms.ErrCodeDependencyTimeoutException, aerr.Error())
        case kms.ErrCodeInternalException:
            fmt.Println(kms.ErrCodeInternalException, aerr.Error())
        case kms.ErrCodeInvalidStateException:
            fmt.Println(kms.ErrCodeInvalidStateException, aerr.Error())
        default:
            fmt.Println(aerr.Error())
        }
    } else {
        // Print the error, cast err to awserr.Error to get the Code and
        // Message from an error.
        fmt.Println(err.Error())
    }
    return
}

fmt.Println(result)

func (*KMS) UpdateKeyDescriptionRequest

func (c *KMS) UpdateKeyDescriptionRequest(input *UpdateKeyDescriptionInput) (req *request.Request, output *UpdateKeyDescriptionOutput)

UpdateKeyDescriptionRequest generates a "aws/request.Request" representing the client's request for the UpdateKeyDescription operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateKeyDescription for more information on using the UpdateKeyDescription API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateKeyDescriptionRequest method.
req, resp := client.UpdateKeyDescriptionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/UpdateKeyDescription

func (*KMS) UpdateKeyDescriptionWithContext

func (c *KMS) UpdateKeyDescriptionWithContext(ctx aws.Context, input *UpdateKeyDescriptionInput, opts ...request.Option) (*UpdateKeyDescriptionOutput, error)

UpdateKeyDescriptionWithContext is the same as UpdateKeyDescription with the addition of the ability to pass a context and additional request options.

See UpdateKeyDescription for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*KMS) Verify

func (c *KMS) Verify(input *VerifyInput) (*VerifyOutput, error)

Verify API operation for AWS Key Management Service.

Verifies a digital signature that was generated by the Sign operation.

Verification confirms that an authorized user signed the message with the specified CMK and signing algorithm, and the message hasn't changed since it was signed. If the signature is verified, the value of the SignatureValid field in the response is True. If the signature verification fails, the Verify operation fails with an KMSInvalidSignatureException exception.

A digital signature is generated by using the private key in an asymmetric CMK. The signature is verified by using the public key in the same asymmetric CMK. For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs (https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) in the AWS Key Management Service Developer Guide.

To verify a digital signature, you can use the Verify operation. Specify the same asymmetric CMK, message, and signing algorithm that were used to produce the signature.

You can also verify the digital signature by using the public key of the CMK outside of AWS KMS. Use the GetPublicKey operation to download the public key in the asymmetric CMK and then use the public key to verify the signature outside of AWS KMS. The advantage of using the Verify operation is that it is performed within AWS KMS. As a result, it's easy to call, the operation is performed within the FIPS boundary, it is logged in AWS CloudTrail, and you can use key policy and IAM policy to determine who is authorized to use the CMK to verify signatures.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the AWS Key Management Service Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Key Management Service's API operation Verify for usage and error information.

Returned Error Types:

* NotFoundException
The request was rejected because the specified entity or resource could not
be found.

* DisabledException
The request was rejected because the specified CMK is not enabled.

* KeyUnavailableException
The request was rejected because the specified CMK was not available. You
can retry the request.

* DependencyTimeoutException
The system timed out while trying to fulfill the request. The request can
be retried.

* InvalidKeyUsageException
The request was rejected for one of the following reasons:

   * The KeyUsage value of the CMK 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 CMK (CustomerMasterKeySpec).

For encrypting, decrypting, re-encrypting, and generating data keys, the
KeyUsage must be ENCRYPT_DECRYPT. For signing and verifying, the KeyUsage
must be SIGN_VERIFY. To find the KeyUsage of a CMK, use the DescribeKey operation.

To find the encryption or signing algorithms supported for a particular CMK,
use the DescribeKey operation.

* InvalidGrantTokenException
The request was rejected because the specified grant token is not valid.

* InternalException
The request was rejected because an internal exception occurred. The request
can be retried.

* InvalidStateException
The request was rejected because the state of the specified resource is not
valid for this request.

For more information about how key state affects the use of a CMK, see How
Key State Affects Use of a Customer Master Key (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html)
in the AWS Key Management Service Developer Guide .

* KMSInvalidSignatureException
The request was rejected because the signature verification failed. Signature
verification fails when it cannot confirm that signature was produced by
signing the specified message with the specified CMK and signing algorithm.

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/Verify

func (*KMS) VerifyRequest

func (c *KMS) VerifyRequest(input *VerifyInput) (req *request.Request, output *VerifyOutput)

VerifyRequest generates a "aws/request.Request" representing the client's request for the Verify operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See Verify for more information on using the Verify API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the VerifyRequest method.
req, resp := client.VerifyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/Verify

func (*KMS) VerifyWithContext

func (c *KMS) VerifyWithContext(ctx aws.Context, input *VerifyInput, opts ...request.Option) (*VerifyOutput, error)

VerifyWithContext is the same as Verify with the addition of the ability to pass a context and additional request options.

See Verify for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type KMSInvalidSignatureException

type KMSInvalidSignatureException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

The request was rejected because the signature verification failed. Signature verification fails when it cannot confirm that signature was produced by signing the specified message with the specified CMK and signing algorithm.

func (*KMSInvalidSignatureException) Code

func (s *KMSInvalidSignatureException) Code() string

Code returns the exception type name.

func (*KMSInvalidSignatureException) Error

func (s *KMSInvalidSignatureException) Error() string

func (KMSInvalidSignatureException) GoString

func (s KMSInvalidSignatureException) GoString() string

GoString returns the string representation

func (*KMSInvalidSignatureException) Message

func (s *KMSInvalidSignatureException) Message() string

Message returns the exception's message.

func (*KMSInvalidSignatureException) OrigErr

func (s *KMSInvalidSignatureException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*KMSInvalidSignatureException) RequestID

func (s *KMSInvalidSignatureException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*KMSInvalidSignatureException) StatusCode

func (s *KMSInvalidSignatureException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (KMSInvalidSignatureException) String

func (s KMSInvalidSignatureException) String() string

String returns the string representation

type KeyListEntry

type KeyListEntry struct {

    // ARN of the key.
    KeyArn *string `min:"20" type:"string"`

    // Unique identifier of the key.
    KeyId *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

Contains information about each entry in the key list.

func (KeyListEntry) GoString

func (s KeyListEntry) GoString() string

GoString returns the string representation

func (*KeyListEntry) SetKeyArn

func (s *KeyListEntry) SetKeyArn(v string) *KeyListEntry

SetKeyArn sets the KeyArn field's value.

func (*KeyListEntry) SetKeyId

func (s *KeyListEntry) SetKeyId(v string) *KeyListEntry

SetKeyId sets the KeyId field's value.

func (KeyListEntry) String

func (s KeyListEntry) String() string

String returns the string representation

type KeyMetadata

type KeyMetadata struct {

    // The twelve-digit account ID of the AWS account that owns the CMK.
    AWSAccountId *string `type:"string"`

    // The Amazon Resource Name (ARN) of the CMK. For examples, see AWS Key Management
    // Service (AWS KMS) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms)
    // in the Example ARNs section of the AWS General Reference.
    Arn *string `min:"20" type:"string"`

    // The cluster ID of the AWS CloudHSM cluster that contains the key material
    // for the CMK. When you create a CMK in a custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html),
    // AWS KMS creates the key material for the CMK in the associated AWS CloudHSM
    // cluster. This value is present only when the CMK is created in a custom key
    // store.
    CloudHsmClusterId *string `min:"19" type:"string"`

    // The date and time when the CMK was created.
    CreationDate *time.Time `type:"timestamp"`

    // A unique identifier for the custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html)
    // that contains the CMK. This value is present only when the CMK is created
    // in a custom key store.
    CustomKeyStoreId *string `min:"1" type:"string"`

    // Describes the type of key material in the CMK.
    CustomerMasterKeySpec *string `type:"string" enum:"CustomerMasterKeySpec"`

    // The date and time after which AWS KMS deletes the CMK. This value is present
    // only when KeyState is PendingDeletion.
    DeletionDate *time.Time `type:"timestamp"`

    // The description of the CMK.
    Description *string `type:"string"`

    // Specifies whether the CMK is enabled. When KeyState is Enabled this value
    // is true, otherwise it is false.
    Enabled *bool `type:"boolean"`

    // The encryption algorithms that the CMK supports. You cannot use the CMK with
    // other encryption algorithms within AWS KMS.
    //
    // This field appears only when the KeyUsage of the CMK is ENCRYPT_DECRYPT.
    EncryptionAlgorithms []*string `type:"list"`

    // Specifies whether the CMK's key material expires. This value is present only
    // when Origin is EXTERNAL, otherwise this value is omitted.
    ExpirationModel *string `type:"string" enum:"ExpirationModelType"`

    // The globally unique identifier for the CMK.
    //
    // KeyId is a required field
    KeyId *string `min:"1" type:"string" required:"true"`

    // The manager of the CMK. CMKs in your AWS account are either customer managed
    // or AWS managed. For more information about the difference, see Customer Master
    // Keys (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys)
    // in the AWS Key Management Service Developer Guide.
    KeyManager *string `type:"string" enum:"KeyManagerType"`

    // The current status of the CMK.
    //
    // For more information about how key state affects the use of a CMK, see Key
    // state: Effect on your CMK (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html)
    // in the AWS Key Management Service Developer Guide.
    KeyState *string `type:"string" enum:"KeyState"`

    // The cryptographic operations (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations)
    // for which you can use the CMK.
    KeyUsage *string `type:"string" enum:"KeyUsageType"`

    // The source of the CMK's key material. When this value is AWS_KMS, AWS KMS
    // created the key material. When this value is EXTERNAL, the key material was
    // imported from your existing key management infrastructure or the CMK lacks
    // key material. When this value is AWS_CLOUDHSM, the key material was created
    // in the AWS CloudHSM cluster associated with a custom key store.
    Origin *string `type:"string" enum:"OriginType"`

    // The signing algorithms that the CMK supports. You cannot use the CMK with
    // other signing algorithms within AWS KMS.
    //
    // This field appears only when the KeyUsage of the CMK is SIGN_VERIFY.
    SigningAlgorithms []*string `type:"list"`

    // The time at which the imported key material expires. When the key material
    // expires, AWS KMS deletes the key material and the CMK becomes unusable. This
    // value is present only for CMKs whose Origin is EXTERNAL and whose ExpirationModel
    // is KEY_MATERIAL_EXPIRES, otherwise this value is omitted.
    ValidTo *time.Time `type:"timestamp"`
    // contains filtered or unexported fields
}

Contains metadata about a customer master key (CMK).

This data type is used as a response element for the CreateKey and DescribeKey operations.

func (KeyMetadata) GoString

func (s KeyMetadata) GoString() string

GoString returns the string representation

func (*KeyMetadata) SetAWSAccountId

func (s *KeyMetadata) SetAWSAccountId(v string) *KeyMetadata

SetAWSAccountId sets the AWSAccountId field's value.

func (*KeyMetadata) SetArn

func (s *KeyMetadata) SetArn(v string) *KeyMetadata

SetArn sets the Arn field's value.

func (*KeyMetadata) SetCloudHsmClusterId

func (s *KeyMetadata) SetCloudHsmClusterId(v string) *KeyMetadata

SetCloudHsmClusterId sets the CloudHsmClusterId field's value.

func (*KeyMetadata) SetCreationDate

func (s *KeyMetadata) SetCreationDate(v time.Time) *KeyMetadata

SetCreationDate sets the CreationDate field's value.

func (*KeyMetadata) SetCustomKeyStoreId

func (s *KeyMetadata) SetCustomKeyStoreId(v string) *KeyMetadata

SetCustomKeyStoreId sets the CustomKeyStoreId field's value.

func (*KeyMetadata) SetCustomerMasterKeySpec

func (s *KeyMetadata) SetCustomerMasterKeySpec(v string) *KeyMetadata

SetCustomerMasterKeySpec sets the CustomerMasterKeySpec field's value.

func (*KeyMetadata) SetDeletionDate

func (s *KeyMetadata) SetDeletionDate(v time.Time) *KeyMetadata

SetDeletionDate sets the DeletionDate field's value.

func (*KeyMetadata) SetDescription

func (s *KeyMetadata) SetDescription(v string) *KeyMetadata

SetDescription sets the Description field's value.

func (*KeyMetadata) SetEnabled

func (s *KeyMetadata) SetEnabled(v bool) *KeyMetadata

SetEnabled sets the Enabled field's value.

func (*KeyMetadata) SetEncryptionAlgorithms

func (s *KeyMetadata) SetEncryptionAlgorithms(v []*string) *KeyMetadata

SetEncryptionAlgorithms sets the EncryptionAlgorithms field's value.

func (*KeyMetadata) SetExpirationModel

func (s *KeyMetadata) SetExpirationModel(v string) *KeyMetadata

SetExpirationModel sets the ExpirationModel field's value.

func (*KeyMetadata) SetKeyId

func (s *KeyMetadata) SetKeyId(v string) *KeyMetadata

SetKeyId sets the KeyId field's value.

func (*KeyMetadata) SetKeyManager

func (s *KeyMetadata) SetKeyManager(v string) *KeyMetadata

SetKeyManager sets the KeyManager field's value.

func (*KeyMetadata) SetKeyState

func (s *KeyMetadata) SetKeyState(v string) *KeyMetadata

SetKeyState sets the KeyState field's value.

func (*KeyMetadata) SetKeyUsage

func (s *KeyMetadata) SetKeyUsage(v string) *KeyMetadata

SetKeyUsage sets the KeyUsage field's value.

func (*KeyMetadata) SetOrigin

func (s *KeyMetadata) SetOrigin(v string) *KeyMetadata

SetOrigin sets the Origin field's value.

func (*KeyMetadata) SetSigningAlgorithms

func (s *KeyMetadata) SetSigningAlgorithms(v []*string) *KeyMetadata

SetSigningAlgorithms sets the SigningAlgorithms field's value.

func (*KeyMetadata) SetValidTo

func (s *KeyMetadata) SetValidTo(v time.Time) *KeyMetadata

SetValidTo sets the ValidTo field's value.

func (KeyMetadata) String

func (s KeyMetadata) String() string

String returns the string representation

type KeyUnavailableException

type KeyUnavailableException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

The request was rejected because the specified CMK was not available. You can retry the request.

func (*KeyUnavailableException) Code

func (s *KeyUnavailableException) Code() string

Code returns the exception type name.

func (*KeyUnavailableException) Error

func (s *KeyUnavailableException) Error() string

func (KeyUnavailableException) GoString

func (s KeyUnavailableException) GoString() string

GoString returns the string representation

func (*KeyUnavailableException) Message

func (s *KeyUnavailableException) Message() string

Message returns the exception's message.

func (*KeyUnavailableException) OrigErr

func (s *KeyUnavailableException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*KeyUnavailableException) RequestID

func (s *KeyUnavailableException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*KeyUnavailableException) StatusCode

func (s *KeyUnavailableException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (KeyUnavailableException) String

func (s KeyUnavailableException) String() string

String returns the string representation

type LimitExceededException

type LimitExceededException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

The request was rejected because a quota was exceeded. For more information, see Quotas (https://docs.aws.amazon.com/kms/latest/developerguide/limits.html) in the AWS Key Management Service Developer Guide.

func (*LimitExceededException) Code

func (s *LimitExceededException) Code() string

Code returns the exception type name.

func (*LimitExceededException) Error

func (s *LimitExceededException) Error() string

func (LimitExceededException) GoString

func (s LimitExceededException) GoString() string

GoString returns the string representation

func (*LimitExceededException) Message

func (s *LimitExceededException) Message() string

Message returns the exception's message.

func (*LimitExceededException) OrigErr

func (s *LimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitExceededException) RequestID

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode

func (s *LimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (LimitExceededException) String

func (s LimitExceededException) String() string

String returns the string representation

type ListAliasesInput

type ListAliasesInput struct {

    // Lists only aliases that refer to the specified CMK. The value of this parameter
    // can be the ID or Amazon Resource Name (ARN) of a CMK in the caller's account
    // and region. You cannot use an alias name or alias ARN in this value.
    //
    // This parameter is optional. If you omit it, ListAliases returns all aliases
    // in the account and region.
    KeyId *string `min:"1" type:"string"`

    // Use this parameter to specify the maximum number of items to return. When
    // this value is present, AWS KMS does not return more than the specified number
    // of items, but it might return fewer.
    //
    // This value is optional. If you include a value, it must be between 1 and
    // 100, inclusive. If you do not include a value, it defaults to 50.
    Limit *int64 `min:"1" type:"integer"`

    // Use this parameter in a subsequent request after you receive a response with
    // truncated results. Set it to the value of NextMarker from the truncated response
    // you just received.
    Marker *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListAliasesInput) GoString

func (s ListAliasesInput) GoString() string

GoString returns the string representation

func (*ListAliasesInput) SetKeyId

func (s *ListAliasesInput) SetKeyId(v string) *ListAliasesInput

SetKeyId sets the KeyId field's value.

func (*ListAliasesInput) SetLimit

func (s *ListAliasesInput) SetLimit(v int64) *ListAliasesInput

SetLimit sets the Limit field's value.

func (*ListAliasesInput) SetMarker

func (s *ListAliasesInput) SetMarker(v string) *ListAliasesInput

SetMarker sets the Marker field's value.

func (ListAliasesInput) String

func (s ListAliasesInput) String() string

String returns the string representation

func (*ListAliasesInput) Validate

func (s *ListAliasesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAliasesOutput

type ListAliasesOutput struct {

    // A list of aliases.
    Aliases []*AliasListEntry `type:"list"`

    // When Truncated is true, this element is present and contains the value to
    // use for the Marker parameter in a subsequent request.
    NextMarker *string `min:"1" type:"string"`

    // A flag that indicates whether there are more items in the list. When this
    // value is true, the list in this response is truncated. To get more items,
    // pass the value of the NextMarker element in thisresponse to the Marker parameter
    // in a subsequent request.
    Truncated *bool `type:"boolean"`
    // contains filtered or unexported fields
}

func (ListAliasesOutput) GoString

func (s ListAliasesOutput) GoString() string

GoString returns the string representation

func (*ListAliasesOutput) SetAliases

func (s *ListAliasesOutput) SetAliases(v []*AliasListEntry) *ListAliasesOutput

SetAliases sets the Aliases field's value.

func (*ListAliasesOutput) SetNextMarker

func (s *ListAliasesOutput) SetNextMarker(v string) *ListAliasesOutput

SetNextMarker sets the NextMarker field's value.

func (*ListAliasesOutput) SetTruncated

func (s *ListAliasesOutput) SetTruncated(v bool) *ListAliasesOutput

SetTruncated sets the Truncated field's value.

func (ListAliasesOutput) String

func (s ListAliasesOutput) String() string

String returns the string representation

type ListGrantsInput

type ListGrantsInput struct {

    // A unique identifier for the customer master key (CMK).
    //
    // Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify
    // a CMK in a different AWS account, you must use the key ARN.
    //
    // For example:
    //
    //    * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    //
    //    * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    //
    // To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
    //
    // KeyId is a required field
    KeyId *string `min:"1" type:"string" required:"true"`

    // Use this parameter to specify the maximum number of items to return. When
    // this value is present, AWS KMS does not return more than the specified number
    // of items, but it might return fewer.
    //
    // This value is optional. If you include a value, it must be between 1 and
    // 100, inclusive. If you do not include a value, it defaults to 50.
    Limit *int64 `min:"1" type:"integer"`

    // Use this parameter in a subsequent request after you receive a response with
    // truncated results. Set it to the value of NextMarker from the truncated response
    // you just received.
    Marker *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListGrantsInput) GoString

func (s ListGrantsInput) GoString() string

GoString returns the string representation

func (*ListGrantsInput) SetKeyId

func (s *ListGrantsInput) SetKeyId(v string) *ListGrantsInput

SetKeyId sets the KeyId field's value.

func (*ListGrantsInput) SetLimit

func (s *ListGrantsInput) SetLimit(v int64) *ListGrantsInput

SetLimit sets the Limit field's value.

func (*ListGrantsInput) SetMarker

func (s *ListGrantsInput) SetMarker(v string) *ListGrantsInput

SetMarker sets the Marker field's value.

func (ListGrantsInput) String

func (s ListGrantsInput) String() string

String returns the string representation

func (*ListGrantsInput) Validate

func (s *ListGrantsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListGrantsResponse

type ListGrantsResponse struct {

    // A list of grants.
    Grants []*GrantListEntry `type:"list"`

    // When Truncated is true, this element is present and contains the value to
    // use for the Marker parameter in a subsequent request.
    NextMarker *string `min:"1" type:"string"`

    // A flag that indicates whether there are more items in the list. When this
    // value is true, the list in this response is truncated. To get more items,
    // pass the value of the NextMarker element in thisresponse to the Marker parameter
    // in a subsequent request.
    Truncated *bool `type:"boolean"`
    // contains filtered or unexported fields
}

func (ListGrantsResponse) GoString

func (s ListGrantsResponse) GoString() string

GoString returns the string representation

func (*ListGrantsResponse) SetGrants

func (s *ListGrantsResponse) SetGrants(v []*GrantListEntry) *ListGrantsResponse

SetGrants sets the Grants field's value.

func (*ListGrantsResponse) SetNextMarker

func (s *ListGrantsResponse) SetNextMarker(v string) *ListGrantsResponse

SetNextMarker sets the NextMarker field's value.

func (*ListGrantsResponse) SetTruncated

func (s *ListGrantsResponse) SetTruncated(v bool) *ListGrantsResponse

SetTruncated sets the Truncated field's value.

func (ListGrantsResponse) String

func (s ListGrantsResponse) String() string

String returns the string representation

type ListKeyPoliciesInput

type ListKeyPoliciesInput struct {

    // A unique identifier for the customer master key (CMK).
    //
    // Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
    //
    // For example:
    //
    //    * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    //
    //    * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    //
    // To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
    //
    // KeyId is a required field
    KeyId *string `min:"1" type:"string" required:"true"`

    // Use this parameter to specify the maximum number of items to return. When
    // this value is present, AWS KMS does not return more than the specified number
    // of items, but it might return fewer.
    //
    // This value is optional. If you include a value, it must be between 1 and
    // 1000, inclusive. If you do not include a value, it defaults to 100.
    //
    // Only one policy can be attached to a key.
    Limit *int64 `min:"1" type:"integer"`

    // Use this parameter in a subsequent request after you receive a response with
    // truncated results. Set it to the value of NextMarker from the truncated response
    // you just received.
    Marker *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListKeyPoliciesInput) GoString

func (s ListKeyPoliciesInput) GoString() string

GoString returns the string representation

func (*ListKeyPoliciesInput) SetKeyId

func (s *ListKeyPoliciesInput) SetKeyId(v string) *ListKeyPoliciesInput

SetKeyId sets the KeyId field's value.

func (*ListKeyPoliciesInput) SetLimit

func (s *ListKeyPoliciesInput) SetLimit(v int64) *ListKeyPoliciesInput

SetLimit sets the Limit field's value.

func (*ListKeyPoliciesInput) SetMarker

func (s *ListKeyPoliciesInput) SetMarker(v string) *ListKeyPoliciesInput

SetMarker sets the Marker field's value.

func (ListKeyPoliciesInput) String

func (s ListKeyPoliciesInput) String() string

String returns the string representation

func (*ListKeyPoliciesInput) Validate

func (s *ListKeyPoliciesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListKeyPoliciesOutput

type ListKeyPoliciesOutput struct {

    // When Truncated is true, this element is present and contains the value to
    // use for the Marker parameter in a subsequent request.
    NextMarker *string `min:"1" type:"string"`

    // A list of key policy names. The only valid value is default.
    PolicyNames []*string `type:"list"`

    // A flag that indicates whether there are more items in the list. When this
    // value is true, the list in this response is truncated. To get more items,
    // pass the value of the NextMarker element in thisresponse to the Marker parameter
    // in a subsequent request.
    Truncated *bool `type:"boolean"`
    // contains filtered or unexported fields
}

func (ListKeyPoliciesOutput) GoString

func (s ListKeyPoliciesOutput) GoString() string

GoString returns the string representation

func (*ListKeyPoliciesOutput) SetNextMarker

func (s *ListKeyPoliciesOutput) SetNextMarker(v string) *ListKeyPoliciesOutput

SetNextMarker sets the NextMarker field's value.

func (*ListKeyPoliciesOutput) SetPolicyNames

func (s *ListKeyPoliciesOutput) SetPolicyNames(v []*string) *ListKeyPoliciesOutput

SetPolicyNames sets the PolicyNames field's value.

func (*ListKeyPoliciesOutput) SetTruncated

func (s *ListKeyPoliciesOutput) SetTruncated(v bool) *ListKeyPoliciesOutput

SetTruncated sets the Truncated field's value.

func (ListKeyPoliciesOutput) String

func (s ListKeyPoliciesOutput) String() string

String returns the string representation

type ListKeysInput

type ListKeysInput struct {

    // Use this parameter to specify the maximum number of items to return. When
    // this value is present, AWS KMS does not return more than the specified number
    // of items, but it might return fewer.
    //
    // This value is optional. If you include a value, it must be between 1 and
    // 1000, inclusive. If you do not include a value, it defaults to 100.
    Limit *int64 `min:"1" type:"integer"`

    // Use this parameter in a subsequent request after you receive a response with
    // truncated results. Set it to the value of NextMarker from the truncated response
    // you just received.
    Marker *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListKeysInput) GoString

func (s ListKeysInput) GoString() string

GoString returns the string representation

func (*ListKeysInput) SetLimit

func (s *ListKeysInput) SetLimit(v int64) *ListKeysInput

SetLimit sets the Limit field's value.

func (*ListKeysInput) SetMarker

func (s *ListKeysInput) SetMarker(v string) *ListKeysInput

SetMarker sets the Marker field's value.

func (ListKeysInput) String

func (s ListKeysInput) String() string

String returns the string representation

func (*ListKeysInput) Validate

func (s *ListKeysInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListKeysOutput

type ListKeysOutput struct {

    // A list of customer master keys (CMKs).
    Keys []*KeyListEntry `type:"list"`

    // When Truncated is true, this element is present and contains the value to
    // use for the Marker parameter in a subsequent request.
    NextMarker *string `min:"1" type:"string"`

    // A flag that indicates whether there are more items in the list. When this
    // value is true, the list in this response is truncated. To get more items,
    // pass the value of the NextMarker element in thisresponse to the Marker parameter
    // in a subsequent request.
    Truncated *bool `type:"boolean"`
    // contains filtered or unexported fields
}

func (ListKeysOutput) GoString

func (s ListKeysOutput) GoString() string

GoString returns the string representation

func (*ListKeysOutput) SetKeys

func (s *ListKeysOutput) SetKeys(v []*KeyListEntry) *ListKeysOutput

SetKeys sets the Keys field's value.

func (*ListKeysOutput) SetNextMarker

func (s *ListKeysOutput) SetNextMarker(v string) *ListKeysOutput

SetNextMarker sets the NextMarker field's value.

func (*ListKeysOutput) SetTruncated

func (s *ListKeysOutput) SetTruncated(v bool) *ListKeysOutput

SetTruncated sets the Truncated field's value.

func (ListKeysOutput) String

func (s ListKeysOutput) String() string

String returns the string representation

type ListResourceTagsInput

type ListResourceTagsInput struct {

    // A unique identifier for the customer master key (CMK).
    //
    // Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
    //
    // For example:
    //
    //    * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    //
    //    * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    //
    // To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
    //
    // KeyId is a required field
    KeyId *string `min:"1" type:"string" required:"true"`

    // Use this parameter to specify the maximum number of items to return. When
    // this value is present, AWS KMS does not return more than the specified number
    // of items, but it might return fewer.
    //
    // This value is optional. If you include a value, it must be between 1 and
    // 50, inclusive. If you do not include a value, it defaults to 50.
    Limit *int64 `min:"1" type:"integer"`

    // Use this parameter in a subsequent request after you receive a response with
    // truncated results. Set it to the value of NextMarker from the truncated response
    // you just received.
    //
    // Do not attempt to construct this value. Use only the value of NextMarker
    // from the truncated response you just received.
    Marker *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ListResourceTagsInput) GoString

func (s ListResourceTagsInput) GoString() string

GoString returns the string representation

func (*ListResourceTagsInput) SetKeyId

func (s *ListResourceTagsInput) SetKeyId(v string) *ListResourceTagsInput

SetKeyId sets the KeyId field's value.

func (*ListResourceTagsInput) SetLimit

func (s *ListResourceTagsInput) SetLimit(v int64) *ListResourceTagsInput

SetLimit sets the Limit field's value.

func (*ListResourceTagsInput) SetMarker

func (s *ListResourceTagsInput) SetMarker(v string) *ListResourceTagsInput

SetMarker sets the Marker field's value.

func (ListResourceTagsInput) String

func (s ListResourceTagsInput) String() string

String returns the string representation

func (*ListResourceTagsInput) Validate

func (s *ListResourceTagsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListResourceTagsOutput

type ListResourceTagsOutput struct {

    // When Truncated is true, this element is present and contains the value to
    // use for the Marker parameter in a subsequent request.
    //
    // Do not assume or infer any information from this value.
    NextMarker *string `min:"1" type:"string"`

    // A list of tags. Each tag consists of a tag key and a tag value.
    Tags []*Tag `type:"list"`

    // A flag that indicates whether there are more items in the list. When this
    // value is true, the list in this response is truncated. To get more items,
    // pass the value of the NextMarker element in thisresponse to the Marker parameter
    // in a subsequent request.
    Truncated *bool `type:"boolean"`
    // contains filtered or unexported fields
}

func (ListResourceTagsOutput) GoString

func (s ListResourceTagsOutput) GoString() string

GoString returns the string representation

func (*ListResourceTagsOutput) SetNextMarker

func (s *ListResourceTagsOutput) SetNextMarker(v string) *ListResourceTagsOutput

SetNextMarker sets the NextMarker field's value.

func (*ListResourceTagsOutput) SetTags

func (s *ListResourceTagsOutput) SetTags(v []*Tag) *ListResourceTagsOutput

SetTags sets the Tags field's value.

func (*ListResourceTagsOutput) SetTruncated

func (s *ListResourceTagsOutput) SetTruncated(v bool) *ListResourceTagsOutput

SetTruncated sets the Truncated field's value.

func (ListResourceTagsOutput) String

func (s ListResourceTagsOutput) String() string

String returns the string representation

type ListRetirableGrantsInput

type ListRetirableGrantsInput struct {

    // Use this parameter to specify the maximum number of items to return. When
    // this value is present, AWS KMS does not return more than the specified number
    // of items, but it might return fewer.
    //
    // This value is optional. If you include a value, it must be between 1 and
    // 100, inclusive. If you do not include a value, it defaults to 50.
    Limit *int64 `min:"1" type:"integer"`

    // Use this parameter in a subsequent request after you receive a response with
    // truncated results. Set it to the value of NextMarker from the truncated response
    // you just received.
    Marker *string `min:"1" type:"string"`

    // The retiring principal for which to list grants.
    //
    // To specify the retiring principal, use the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
    // of an AWS principal. Valid AWS principals include AWS accounts (root), IAM
    // users, federated users, and assumed role users. For examples of the ARN syntax
    // for specifying a principal, see AWS Identity and Access Management (IAM)
    // (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam)
    // in the Example ARNs section of the Amazon Web Services General Reference.
    //
    // RetiringPrincipal is a required field
    RetiringPrincipal *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (ListRetirableGrantsInput) GoString

func (s ListRetirableGrantsInput) GoString() string

GoString returns the string representation

func (*ListRetirableGrantsInput) SetLimit

func (s *ListRetirableGrantsInput) SetLimit(v int64) *ListRetirableGrantsInput

SetLimit sets the Limit field's value.

func (*ListRetirableGrantsInput) SetMarker

func (s *ListRetirableGrantsInput) SetMarker(v string) *ListRetirableGrantsInput

SetMarker sets the Marker field's value.

func (*ListRetirableGrantsInput) SetRetiringPrincipal

func (s *ListRetirableGrantsInput) SetRetiringPrincipal(v string) *ListRetirableGrantsInput

SetRetiringPrincipal sets the RetiringPrincipal field's value.

func (ListRetirableGrantsInput) String

func (s ListRetirableGrantsInput) String() string

String returns the string representation

func (*ListRetirableGrantsInput) Validate

func (s *ListRetirableGrantsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type MalformedPolicyDocumentException

type MalformedPolicyDocumentException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

The request was rejected because the specified policy is not syntactically or semantically correct.

func (*MalformedPolicyDocumentException) Code

func (s *MalformedPolicyDocumentException) Code() string

Code returns the exception type name.

func (*MalformedPolicyDocumentException) Error

func (s *MalformedPolicyDocumentException) Error() string

func (MalformedPolicyDocumentException) GoString

func (s MalformedPolicyDocumentException) GoString() string

GoString returns the string representation

func (*MalformedPolicyDocumentException) Message

func (s *MalformedPolicyDocumentException) Message() string

Message returns the exception's message.

func (*MalformedPolicyDocumentException) OrigErr

func (s *MalformedPolicyDocumentException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*MalformedPolicyDocumentException) RequestID

func (s *MalformedPolicyDocumentException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*MalformedPolicyDocumentException) StatusCode

func (s *MalformedPolicyDocumentException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (MalformedPolicyDocumentException) String

func (s MalformedPolicyDocumentException) String() string

String returns the string representation

type NotFoundException

type NotFoundException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

The request was rejected because the specified entity or resource could not be found.

func (*NotFoundException) Code

func (s *NotFoundException) Code() string

Code returns the exception type name.

func (*NotFoundException) Error

func (s *NotFoundException) Error() string

func (NotFoundException) GoString

func (s NotFoundException) GoString() string

GoString returns the string representation

func (*NotFoundException) Message

func (s *NotFoundException) Message() string

Message returns the exception's message.

func (*NotFoundException) OrigErr

func (s *NotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*NotFoundException) RequestID

func (s *NotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*NotFoundException) StatusCode

func (s *NotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (NotFoundException) String

func (s NotFoundException) String() string

String returns the string representation

type PutKeyPolicyInput

type PutKeyPolicyInput struct {

    // A flag to indicate whether to bypass the key policy lockout safety check.
    //
    // Setting this value to true increases the risk that the CMK becomes unmanageable.
    // Do not set this value to true indiscriminately.
    //
    // For more information, refer to the scenario in the Default Key Policy (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam)
    // section in the AWS Key Management Service Developer Guide.
    //
    // Use this parameter only when you intend to prevent the principal that is
    // making the request from making a subsequent PutKeyPolicy request on the CMK.
    //
    // The default value is false.
    BypassPolicyLockoutSafetyCheck *bool `type:"boolean"`

    // A unique identifier for the customer master key (CMK).
    //
    // Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
    //
    // For example:
    //
    //    * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    //
    //    * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    //
    // To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
    //
    // KeyId is a required field
    KeyId *string `min:"1" type:"string" required:"true"`

    // The key policy to attach to the CMK.
    //
    // The key policy must meet the following criteria:
    //
    //    * If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy
    //    must allow the principal that is making the PutKeyPolicy request to make
    //    a subsequent PutKeyPolicy request on the CMK. This reduces the risk that
    //    the CMK becomes unmanageable. For more information, refer to the scenario
    //    in the Default Key Policy (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam)
    //    section of the AWS Key Management Service Developer Guide.
    //
    //    * Each statement in the key policy must contain one or more principals.
    //    The principals in the key policy must exist and be visible to AWS KMS.
    //    When you create a new AWS principal (for example, an IAM user or role),
    //    you might need to enforce a delay before including the new principal in
    //    a key policy because the new principal might not be immediately visible
    //    to AWS KMS. For more information, see Changes that I make are not always
    //    immediately visible (https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency)
    //    in the AWS Identity and Access Management User Guide.
    //
    // The key policy cannot exceed 32 kilobytes (32768 bytes). For more information,
    // see Resource Quotas (https://docs.aws.amazon.com/kms/latest/developerguide/resource-limits.html)
    // in the AWS Key Management Service Developer Guide.
    //
    // Policy is a required field
    Policy *string `min:"1" type:"string" required:"true"`

    // The name of the key policy. The only valid value is default.
    //
    // PolicyName is a required field
    PolicyName *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (PutKeyPolicyInput) GoString

func (s PutKeyPolicyInput) GoString() string

GoString returns the string representation

func (*PutKeyPolicyInput) SetBypassPolicyLockoutSafetyCheck

func (s *PutKeyPolicyInput) SetBypassPolicyLockoutSafetyCheck(v bool) *PutKeyPolicyInput

SetBypassPolicyLockoutSafetyCheck sets the BypassPolicyLockoutSafetyCheck field's value.

func (*PutKeyPolicyInput) SetKeyId

func (s *PutKeyPolicyInput) SetKeyId(v string) *PutKeyPolicyInput

SetKeyId sets the KeyId field's value.

func (*PutKeyPolicyInput) SetPolicy

func (s *PutKeyPolicyInput) SetPolicy(v string) *PutKeyPolicyInput

SetPolicy sets the Policy field's value.

func (*PutKeyPolicyInput) SetPolicyName

func (s *PutKeyPolicyInput) SetPolicyName(v string) *PutKeyPolicyInput

SetPolicyName sets the PolicyName field's value.

func (PutKeyPolicyInput) String

func (s PutKeyPolicyInput) String() string

String returns the string representation

func (*PutKeyPolicyInput) Validate

func (s *PutKeyPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutKeyPolicyOutput

type PutKeyPolicyOutput struct {
    // contains filtered or unexported fields
}

func (PutKeyPolicyOutput) GoString

func (s PutKeyPolicyOutput) GoString() string

GoString returns the string representation

func (PutKeyPolicyOutput) String

func (s PutKeyPolicyOutput) String() string

String returns the string representation

type ReEncryptInput

type ReEncryptInput struct {

    // Ciphertext of the data to reencrypt.
    //
    // CiphertextBlob is automatically base64 encoded/decoded by the SDK.
    //
    // CiphertextBlob is a required field
    CiphertextBlob []byte `min:"1" type:"blob" required:"true"`

    // Specifies the encryption algorithm that AWS KMS will use to reecrypt the
    // data after it has decrypted it. The default value, SYMMETRIC_DEFAULT, represents
    // the encryption algorithm used for symmetric CMKs.
    //
    // This parameter is required only when the destination CMK is an asymmetric
    // CMK.
    DestinationEncryptionAlgorithm *string `type:"string" enum:"EncryptionAlgorithmSpec"`

    // Specifies that encryption context to use when the reencrypting the data.
    //
    // A destination encryption context is valid only when the destination CMK is
    // a symmetric CMK. The standard ciphertext format for asymmetric CMKs does
    // not include fields for metadata.
    //
    // An encryption context is a collection of non-secret key-value pairs that
    // represents additional authenticated data. When you use an encryption context
    // to encrypt data, you must specify the same (an exact case-sensitive match)
    // encryption context to decrypt the data. An encryption context is optional
    // when encrypting with a symmetric CMK, but it is highly recommended.
    //
    // For more information, see Encryption Context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context)
    // in the AWS Key Management Service Developer Guide.
    DestinationEncryptionContext map[string]*string `type:"map"`

    // A unique identifier for the CMK that is used to reencrypt the data. Specify
    // a symmetric or asymmetric CMK with a KeyUsage value of ENCRYPT_DECRYPT. To
    // find the KeyUsage value of a CMK, use the DescribeKey operation.
    //
    // To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name,
    // or alias ARN. When using an alias name, prefix it with "alias/". To specify
    // a CMK in a different AWS account, you must use the key ARN or alias ARN.
    //
    // For example:
    //
    //    * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    //
    //    * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    //
    //    * Alias name: alias/ExampleAlias
    //
    //    * Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
    //
    // To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To
    // get the alias name and alias ARN, use ListAliases.
    //
    // DestinationKeyId is a required field
    DestinationKeyId *string `min:"1" type:"string" required:"true"`

    // A list of grant tokens.
    //
    // For more information, see Grant Tokens (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token)
    // in the AWS Key Management Service Developer Guide.
    GrantTokens []*string `type:"list"`

    // Specifies the encryption algorithm that AWS KMS will use to decrypt the ciphertext
    // before it is reencrypted. The default value, SYMMETRIC_DEFAULT, represents
    // the algorithm used for symmetric CMKs.
    //
    // Specify the same algorithm that was used to encrypt the ciphertext. If you
    // specify a different algorithm, the decrypt attempt fails.
    //
    // This parameter is required only when the ciphertext was encrypted under an
    // asymmetric CMK.
    SourceEncryptionAlgorithm *string `type:"string" enum:"EncryptionAlgorithmSpec"`

    // Specifies the encryption context to use to decrypt the ciphertext. Enter
    // the same encryption context that was used to encrypt the ciphertext.
    //
    // An encryption context is a collection of non-secret key-value pairs that
    // represents additional authenticated data. When you use an encryption context
    // to encrypt data, you must specify the same (an exact case-sensitive match)
    // encryption context to decrypt the data. An encryption context is optional
    // when encrypting with a symmetric CMK, but it is highly recommended.
    //
    // For more information, see Encryption Context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context)
    // in the AWS Key Management Service Developer Guide.
    SourceEncryptionContext map[string]*string `type:"map"`

    // A unique identifier for the CMK that is used to decrypt the ciphertext before
    // it reencrypts it using the destination CMK.
    //
    // This parameter is required only when the ciphertext was encrypted under an
    // asymmetric CMK. Otherwise, AWS KMS uses the metadata that it adds to the
    // ciphertext blob to determine which CMK was used to encrypt the ciphertext.
    // However, you can use this parameter to ensure that a particular CMK (of any
    // kind) is used to decrypt the ciphertext before it is reencrypted.
    //
    // If you specify a KeyId value, the decrypt part of the ReEncrypt operation
    // succeeds only if the specified CMK was used to encrypt the ciphertext.
    //
    // To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name,
    // or alias ARN. When using an alias name, prefix it with "alias/".
    //
    // For example:
    //
    //    * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    //
    //    * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    //
    //    * Alias name: alias/ExampleAlias
    //
    //    * Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
    //
    // To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To
    // get the alias name and alias ARN, use ListAliases.
    SourceKeyId *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ReEncryptInput) GoString

func (s ReEncryptInput) GoString() string

GoString returns the string representation

func (*ReEncryptInput) SetCiphertextBlob

func (s *ReEncryptInput) SetCiphertextBlob(v []byte) *ReEncryptInput

SetCiphertextBlob sets the CiphertextBlob field's value.

func (*ReEncryptInput) SetDestinationEncryptionAlgorithm

func (s *ReEncryptInput) SetDestinationEncryptionAlgorithm(v string) *ReEncryptInput

SetDestinationEncryptionAlgorithm sets the DestinationEncryptionAlgorithm field's value.

func (*ReEncryptInput) SetDestinationEncryptionContext

func (s *ReEncryptInput) SetDestinationEncryptionContext(v map[string]*string) *ReEncryptInput

SetDestinationEncryptionContext sets the DestinationEncryptionContext field's value.

func (*ReEncryptInput) SetDestinationKeyId

func (s *ReEncryptInput) SetDestinationKeyId(v string) *ReEncryptInput

SetDestinationKeyId sets the DestinationKeyId field's value.

func (*ReEncryptInput) SetGrantTokens

func (s *ReEncryptInput) SetGrantTokens(v []*string) *ReEncryptInput

SetGrantTokens sets the GrantTokens field's value.

func (*ReEncryptInput) SetSourceEncryptionAlgorithm

func (s *ReEncryptInput) SetSourceEncryptionAlgorithm(v string) *ReEncryptInput

SetSourceEncryptionAlgorithm sets the SourceEncryptionAlgorithm field's value.

func (*ReEncryptInput) SetSourceEncryptionContext

func (s *ReEncryptInput) SetSourceEncryptionContext(v map[string]*string) *ReEncryptInput

SetSourceEncryptionContext sets the SourceEncryptionContext field's value.

func (*ReEncryptInput) SetSourceKeyId

func (s *ReEncryptInput) SetSourceKeyId(v string) *ReEncryptInput

SetSourceKeyId sets the SourceKeyId field's value.

func (ReEncryptInput) String

func (s ReEncryptInput) String() string

String returns the string representation

func (*ReEncryptInput) Validate

func (s *ReEncryptInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ReEncryptOutput

type ReEncryptOutput struct {

    // The reencrypted data. When you use the HTTP API or the AWS CLI, the value
    // is Base64-encoded. Otherwise, it is not Base64-encoded.
    //
    // CiphertextBlob is automatically base64 encoded/decoded by the SDK.
    CiphertextBlob []byte `min:"1" type:"blob"`

    // The encryption algorithm that was used to reencrypt the data.
    DestinationEncryptionAlgorithm *string `type:"string" enum:"EncryptionAlgorithmSpec"`

    // The Amazon Resource Name (key ARN (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN))
    // of the CMK that was used to reencrypt the data.
    KeyId *string `min:"1" type:"string"`

    // The encryption algorithm that was used to decrypt the ciphertext before it
    // was reencrypted.
    SourceEncryptionAlgorithm *string `type:"string" enum:"EncryptionAlgorithmSpec"`

    // Unique identifier of the CMK used to originally encrypt the data.
    SourceKeyId *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ReEncryptOutput) GoString

func (s ReEncryptOutput) GoString() string

GoString returns the string representation

func (*ReEncryptOutput) SetCiphertextBlob

func (s *ReEncryptOutput) SetCiphertextBlob(v []byte) *ReEncryptOutput

SetCiphertextBlob sets the CiphertextBlob field's value.

func (*ReEncryptOutput) SetDestinationEncryptionAlgorithm

func (s *ReEncryptOutput) SetDestinationEncryptionAlgorithm(v string) *ReEncryptOutput

SetDestinationEncryptionAlgorithm sets the DestinationEncryptionAlgorithm field's value.

func (*ReEncryptOutput) SetKeyId

func (s *ReEncryptOutput) SetKeyId(v string) *ReEncryptOutput

SetKeyId sets the KeyId field's value.

func (*ReEncryptOutput) SetSourceEncryptionAlgorithm

func (s *ReEncryptOutput) SetSourceEncryptionAlgorithm(v string) *ReEncryptOutput

SetSourceEncryptionAlgorithm sets the SourceEncryptionAlgorithm field's value.

func (*ReEncryptOutput) SetSourceKeyId

func (s *ReEncryptOutput) SetSourceKeyId(v string) *ReEncryptOutput

SetSourceKeyId sets the SourceKeyId field's value.

func (ReEncryptOutput) String

func (s ReEncryptOutput) String() string

String returns the string representation

type RetireGrantInput

type RetireGrantInput struct {

    // Unique identifier of the grant to retire. The grant ID is returned in the
    // response to a CreateGrant operation.
    //
    //    * Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123
    GrantId *string `min:"1" type:"string"`

    // Token that identifies the grant to be retired.
    GrantToken *string `min:"1" type:"string"`

    // The Amazon Resource Name (ARN) of the CMK associated with the grant.
    //
    // For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab
    KeyId *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (RetireGrantInput) GoString

func (s RetireGrantInput) GoString() string

GoString returns the string representation

func (*RetireGrantInput) SetGrantId

func (s *RetireGrantInput) SetGrantId(v string) *RetireGrantInput

SetGrantId sets the GrantId field's value.

func (*RetireGrantInput) SetGrantToken

func (s *RetireGrantInput) SetGrantToken(v string) *RetireGrantInput

SetGrantToken sets the GrantToken field's value.

func (*RetireGrantInput) SetKeyId

func (s *RetireGrantInput) SetKeyId(v string) *RetireGrantInput

SetKeyId sets the KeyId field's value.

func (RetireGrantInput) String

func (s RetireGrantInput) String() string

String returns the string representation

func (*RetireGrantInput) Validate

func (s *RetireGrantInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RetireGrantOutput

type RetireGrantOutput struct {
    // contains filtered or unexported fields
}

func (RetireGrantOutput) GoString

func (s RetireGrantOutput) GoString() string

GoString returns the string representation

func (RetireGrantOutput) String

func (s RetireGrantOutput) String() string

String returns the string representation

type RevokeGrantInput

type RevokeGrantInput struct {

    // Identifier of the grant to be revoked.
    //
    // GrantId is a required field
    GrantId *string `min:"1" type:"string" required:"true"`

    // A unique identifier for the customer master key associated with the grant.
    //
    // Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify
    // a CMK in a different AWS account, you must use the key ARN.
    //
    // For example:
    //
    //    * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    //
    //    * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    //
    // To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
    //
    // KeyId is a required field
    KeyId *string `min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (RevokeGrantInput) GoString

func (s RevokeGrantInput) GoString() string

GoString returns the string representation

func (*RevokeGrantInput) SetGrantId

func (s *RevokeGrantInput) SetGrantId(v string) *RevokeGrantInput

SetGrantId sets the GrantId field's value.

func (*RevokeGrantInput) SetKeyId

func (s *RevokeGrantInput) SetKeyId(v string) *RevokeGrantInput

SetKeyId sets the KeyId field's value.

func (RevokeGrantInput) String

func (s RevokeGrantInput) String() string

String returns the string representation

func (*RevokeGrantInput) Validate

func (s *RevokeGrantInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RevokeGrantOutput

type RevokeGrantOutput struct {
    // contains filtered or unexported fields
}

func (RevokeGrantOutput) GoString

func (s RevokeGrantOutput) GoString() string

GoString returns the string representation

func (RevokeGrantOutput) String

func (s RevokeGrantOutput) String() string

String returns the string representation

type ScheduleKeyDeletionInput

type ScheduleKeyDeletionInput struct {

    // The unique identifier of the customer master key (CMK) to delete.
    //
    // Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
    //
    // For example:
    //
    //    * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    //
    //    * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    //
    // To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
    //
    // KeyId is a required field
    KeyId *string `min:"1" type:"string" required:"true"`

    // The waiting period, specified in number of days. After the waiting period
    // ends, AWS KMS deletes the customer master key (CMK).
    //
    // This value is optional. If you include a value, it must be between 7 and
    // 30, inclusive. If you do not include a value, it defaults to 30.
    PendingWindowInDays *int64 `min:"1" type:"integer"`
    // contains filtered or unexported fields
}

func (ScheduleKeyDeletionInput) GoString

func (s ScheduleKeyDeletionInput) GoString() string

GoString returns the string representation

func (*ScheduleKeyDeletionInput) SetKeyId

func (s *ScheduleKeyDeletionInput) SetKeyId(v string) *ScheduleKeyDeletionInput

SetKeyId sets the KeyId field's value.

func (*ScheduleKeyDeletionInput) SetPendingWindowInDays

func (s *ScheduleKeyDeletionInput) SetPendingWindowInDays(v int64) *ScheduleKeyDeletionInput

SetPendingWindowInDays sets the PendingWindowInDays field's value.

func (ScheduleKeyDeletionInput) String

func (s ScheduleKeyDeletionInput) String() string

String returns the string representation

func (*ScheduleKeyDeletionInput) Validate

func (s *ScheduleKeyDeletionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ScheduleKeyDeletionOutput

type ScheduleKeyDeletionOutput struct {

    // The date and time after which AWS KMS deletes the customer master key (CMK).
    DeletionDate *time.Time `type:"timestamp"`

    // The Amazon Resource Name (key ARN (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN))
    // of the CMK whose deletion is scheduled.
    KeyId *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ScheduleKeyDeletionOutput) GoString

func (s ScheduleKeyDeletionOutput) GoString() string

GoString returns the string representation

func (*ScheduleKeyDeletionOutput) SetDeletionDate

func (s *ScheduleKeyDeletionOutput) SetDeletionDate(v time.Time) *ScheduleKeyDeletionOutput

SetDeletionDate sets the DeletionDate field's value.

func (*ScheduleKeyDeletionOutput) SetKeyId

func (s *ScheduleKeyDeletionOutput) SetKeyId(v string) *ScheduleKeyDeletionOutput

SetKeyId sets the KeyId field's value.

func (ScheduleKeyDeletionOutput) String

func (s ScheduleKeyDeletionOutput) String() string

String returns the string representation

type SignInput

type SignInput struct {

    // A list of grant tokens.
    //
    // For more information, see Grant Tokens (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token)
    // in the AWS Key Management Service Developer Guide.
    GrantTokens []*string `type:"list"`

    // Identifies an asymmetric CMK. AWS KMS uses the private key in the asymmetric
    // CMK to sign the message. The KeyUsage type of the CMK must be SIGN_VERIFY.
    // To find the KeyUsage of a CMK, use the DescribeKey operation.
    //
    // To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name,
    // or alias ARN. When using an alias name, prefix it with "alias/". To specify
    // a CMK in a different AWS account, you must use the key ARN or alias ARN.
    //
    // For example:
    //
    //    * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    //
    //    * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    //
    //    * Alias name: alias/ExampleAlias
    //
    //    * Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
    //
    // To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To
    // get the alias name and alias ARN, use ListAliases.
    //
    // KeyId is a required field
    KeyId *string `min:"1" type:"string" required:"true"`

    // Specifies the message or message digest to sign. Messages can be 0-4096 bytes.
    // To sign a larger message, provide the message digest.
    //
    // If you provide a message, AWS KMS generates a hash digest of the message
    // and then signs it.
    //
    // Message is automatically base64 encoded/decoded by the SDK.
    //
    // Message is a required field
    Message []byte `min:"1" type:"blob" required:"true" sensitive:"true"`

    // Tells AWS KMS whether the value of the Message parameter is a message or
    // message digest. The default value, RAW, indicates a message. To indicate
    // a message digest, enter DIGEST.
    MessageType *string `type:"string" enum:"MessageType"`

    // Specifies the signing algorithm to use when signing the message.
    //
    // Choose an algorithm that is compatible with the type and size of the specified
    // asymmetric CMK.
    //
    // SigningAlgorithm is a required field
    SigningAlgorithm *string `type:"string" required:"true" enum:"SigningAlgorithmSpec"`
    // contains filtered or unexported fields
}

func (SignInput) GoString

func (s SignInput) GoString() string

GoString returns the string representation

func (*SignInput) SetGrantTokens

func (s *SignInput) SetGrantTokens(v []*string) *SignInput

SetGrantTokens sets the GrantTokens field's value.

func (*SignInput) SetKeyId

func (s *SignInput) SetKeyId(v string) *SignInput

SetKeyId sets the KeyId field's value.

func (*SignInput) SetMessage

func (s *SignInput) SetMessage(v []byte) *SignInput

SetMessage sets the Message field's value.

func (*SignInput) SetMessageType

func (s *SignInput) SetMessageType(v string) *SignInput

SetMessageType sets the MessageType field's value.

func (*SignInput) SetSigningAlgorithm

func (s *SignInput) SetSigningAlgorithm(v string) *SignInput

SetSigningAlgorithm sets the SigningAlgorithm field's value.

func (SignInput) String

func (s SignInput) String() string

String returns the string representation

func (*SignInput) Validate

func (s *SignInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SignOutput

type SignOutput struct {

    // The Amazon Resource Name (key ARN (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN))
    // of the asymmetric CMK that was used to sign the message.
    KeyId *string `min:"1" type:"string"`

    // 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 (https://tools.ietf.org/html/rfc8017).
    //
    //    * 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 ANS X9.62–2005
    //    and RFC 3279 Section 2.2.3 (https://tools.ietf.org/html/rfc3279#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 AWS CLI, the value is Base64-encoded. Otherwise,
    // it is not Base64-encoded.
    //
    // Signature is automatically base64 encoded/decoded by the SDK.
    Signature []byte `min:"1" type:"blob"`

    // The signing algorithm that was used to sign the message.
    SigningAlgorithm *string `type:"string" enum:"SigningAlgorithmSpec"`
    // contains filtered or unexported fields
}

func (SignOutput) GoString

func (s SignOutput) GoString() string

GoString returns the string representation

func (*SignOutput) SetKeyId

func (s *SignOutput) SetKeyId(v string) *SignOutput

SetKeyId sets the KeyId field's value.

func (*SignOutput) SetSignature

func (s *SignOutput) SetSignature(v []byte) *SignOutput

SetSignature sets the Signature field's value.

func (*SignOutput) SetSigningAlgorithm

func (s *SignOutput) SetSigningAlgorithm(v string) *SignOutput

SetSigningAlgorithm sets the SigningAlgorithm field's value.

func (SignOutput) String

func (s SignOutput) String() string

String returns the string representation

type Tag

type Tag struct {

    // The key of the tag.
    //
    // TagKey is a required field
    TagKey *string `min:"1" type:"string" required:"true"`

    // The value of the tag.
    //
    // TagValue is a required field
    TagValue *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.

For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html) in the AWS Billing and Cost Management User Guide.

func (Tag) GoString

func (s Tag) GoString() string

GoString returns the string representation

func (*Tag) SetTagKey

func (s *Tag) SetTagKey(v string) *Tag

SetTagKey sets the TagKey field's value.

func (*Tag) SetTagValue

func (s *Tag) SetTagValue(v string) *Tag

SetTagValue sets the TagValue field's value.

func (Tag) String

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagException

type TagException struct {
    RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

    Message_ *string `locationName:"message" type:"string"`
    // contains filtered or unexported fields
}

The request was rejected because one or more tags are not valid.

func (*TagException) Code

func (s *TagException) Code() string

Code returns the exception type name.

func (*TagException) Error

func (s *TagException) Error() string

func (TagException) GoString

func (s TagException) GoString() string

GoString returns the string representation

func (*TagException) Message

func (s *TagException) Message() string

Message returns the exception's message.

func (*TagException) OrigErr

func (s *TagException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*TagException) RequestID

func (s *TagException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*TagException) StatusCode

func (s *TagException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (TagException) String

func (s TagException) String() string

String returns the string representation

type TagResourceInput

type TagResourceInput struct {

    // A unique identifier for the CMK you are tagging.
    //
    // Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
    //
    // For example:
    //
    //    * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    //
    //    * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    //
    // To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
    //
    // KeyId is a required field
    KeyId *string `min:"1" type:"string" required:"true"`

    // One or more tags. Each tag consists of a tag key and a tag value.
    //
    // Tags is a required field
    Tags []*Tag `type:"list" required:"true"`
    // contains filtered or unexported fields
}

func (TagResourceInput) GoString

func (s TagResourceInput) GoString() string

GoString returns the string representation

func (*TagResourceInput) SetKeyId

func (s *TagResourceInput) SetKeyId(v string) *TagResourceInput

SetKeyId sets the KeyId field's value.

func (*TagResourceInput) SetTags

func (s *