aws-sdk-go: github.com/aws/aws-sdk-go/service/kms Index | Examples | Files | Directories

package kms

import "github.com/aws/aws-sdk-go/service/kms"

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

Index

Examples

Package Files

api.go doc.go errors.go service.go

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"
)
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 (
    // DataKeySpecAes256 is a DataKeySpec enum value
    DataKeySpecAes256 = "AES_256"

    // DataKeySpecAes128 is a DataKeySpec enum value
    DataKeySpecAes128 = "AES_128"
)
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"

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

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

    // GrantOperationDescribeKey is a GrantOperation enum value
    GrantOperationDescribeKey = "DescribeKey"
)
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 (
    // 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 (

    // 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 provided 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"

    // ErrCodeIncorrectKeyMaterialException for service response error code
    // "IncorrectKeyMaterialException".
    //
    // The request was rejected because the provided key material is 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".
    //
    // 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.
    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 because the specified KeySpec value is not valid.
    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"

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

    // ErrCodeLimitExceededException for service response error code
    // "LimitExceededException".
    //
    // The request was rejected because a limit was exceeded. For more information,
    // see Limits (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 identifer of a specific service.
)

Service information constants

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

type AliasListEntry Uses

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 Uses

func (s AliasListEntry) GoString() string

GoString returns the string representation

func (*AliasListEntry) SetAliasArn Uses

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

SetAliasArn sets the AliasArn field's value.

func (*AliasListEntry) SetAliasName Uses

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

SetAliasName sets the AliasName field's value.

func (*AliasListEntry) SetTargetKeyId Uses

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

SetTargetKeyId sets the TargetKeyId field's value.

func (AliasListEntry) String Uses

func (s AliasListEntry) String() string

String returns the string representation

type CancelKeyDeletionInput Uses

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 Uses

func (s CancelKeyDeletionInput) GoString() string

GoString returns the string representation

func (*CancelKeyDeletionInput) SetKeyId Uses

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

SetKeyId sets the KeyId field's value.

func (CancelKeyDeletionInput) String Uses

func (s CancelKeyDeletionInput) String() string

String returns the string representation

func (*CancelKeyDeletionInput) Validate Uses

func (s *CancelKeyDeletionInput) Validate() error

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

type CancelKeyDeletionOutput Uses

type CancelKeyDeletionOutput struct {

    // The unique identifier of the master key for which deletion is canceled.
    KeyId *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (CancelKeyDeletionOutput) GoString Uses

func (s CancelKeyDeletionOutput) GoString() string

GoString returns the string representation

func (*CancelKeyDeletionOutput) SetKeyId Uses

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

SetKeyId sets the KeyId field's value.

func (CancelKeyDeletionOutput) String Uses

func (s CancelKeyDeletionOutput) String() string

String returns the string representation

type ConnectCustomKeyStoreInput Uses

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 Uses

func (s ConnectCustomKeyStoreInput) GoString() string

GoString returns the string representation

func (*ConnectCustomKeyStoreInput) SetCustomKeyStoreId Uses

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

SetCustomKeyStoreId sets the CustomKeyStoreId field's value.

func (ConnectCustomKeyStoreInput) String Uses

func (s ConnectCustomKeyStoreInput) String() string

String returns the string representation

func (*ConnectCustomKeyStoreInput) Validate Uses

func (s *ConnectCustomKeyStoreInput) Validate() error

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

type ConnectCustomKeyStoreOutput Uses

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

func (ConnectCustomKeyStoreOutput) GoString Uses

func (s ConnectCustomKeyStoreOutput) GoString() string

GoString returns the string representation

func (ConnectCustomKeyStoreOutput) String Uses

func (s ConnectCustomKeyStoreOutput) String() string

String returns the string representation

type CreateAliasInput Uses

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 Uses

func (s CreateAliasInput) GoString() string

GoString returns the string representation

func (*CreateAliasInput) SetAliasName Uses

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

SetAliasName sets the AliasName field's value.

func (*CreateAliasInput) SetTargetKeyId Uses

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

SetTargetKeyId sets the TargetKeyId field's value.

func (CreateAliasInput) String Uses

func (s CreateAliasInput) String() string

String returns the string representation

func (*CreateAliasInput) Validate Uses

func (s *CreateAliasInput) Validate() error

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

type CreateAliasOutput Uses

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

func (CreateAliasOutput) GoString Uses

func (s CreateAliasOutput) GoString() string

GoString returns the string representation

func (CreateAliasOutput) String Uses

func (s CreateAliasOutput) String() string

String returns the string representation

type CreateCustomKeyStoreInput Uses

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.
    //
    // 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:"1" 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 Uses

func (s CreateCustomKeyStoreInput) GoString() string

GoString returns the string representation

func (*CreateCustomKeyStoreInput) SetCloudHsmClusterId Uses

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

SetCloudHsmClusterId sets the CloudHsmClusterId field's value.

func (*CreateCustomKeyStoreInput) SetCustomKeyStoreName Uses

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

SetCustomKeyStoreName sets the CustomKeyStoreName field's value.

func (*CreateCustomKeyStoreInput) SetKeyStorePassword Uses

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

SetKeyStorePassword sets the KeyStorePassword field's value.

func (*CreateCustomKeyStoreInput) SetTrustAnchorCertificate Uses

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

SetTrustAnchorCertificate sets the TrustAnchorCertificate field's value.

func (CreateCustomKeyStoreInput) String Uses

func (s CreateCustomKeyStoreInput) String() string

String returns the string representation

func (*CreateCustomKeyStoreInput) Validate Uses

func (s *CreateCustomKeyStoreInput) Validate() error

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

type CreateCustomKeyStoreOutput Uses

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 Uses

func (s CreateCustomKeyStoreOutput) GoString() string

GoString returns the string representation

func (*CreateCustomKeyStoreOutput) SetCustomKeyStoreId Uses

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

SetCustomKeyStoreId sets the CustomKeyStoreId field's value.

func (CreateCustomKeyStoreOutput) String Uses

func (s CreateCustomKeyStoreOutput) String() string

String returns the string representation

type CreateGrantInput Uses

type CreateGrantInput struct {

    // Allows a cryptographic operation 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 Uses

func (s CreateGrantInput) GoString() string

GoString returns the string representation

func (*CreateGrantInput) SetConstraints Uses

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

SetConstraints sets the Constraints field's value.

func (*CreateGrantInput) SetGrantTokens Uses

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

SetGrantTokens sets the GrantTokens field's value.

func (*CreateGrantInput) SetGranteePrincipal Uses

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

SetGranteePrincipal sets the GranteePrincipal field's value.

func (*CreateGrantInput) SetKeyId Uses

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

SetKeyId sets the KeyId field's value.

func (*CreateGrantInput) SetName Uses

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

SetName sets the Name field's value.

func (*CreateGrantInput) SetOperations Uses

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

SetOperations sets the Operations field's value.

func (*CreateGrantInput) SetRetiringPrincipal Uses

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

SetRetiringPrincipal sets the RetiringPrincipal field's value.

func (CreateGrantInput) String Uses

func (s CreateGrantInput) String() string

String returns the string representation

func (*CreateGrantInput) Validate Uses

func (s *CreateGrantInput) Validate() error

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

type CreateGrantOutput Uses

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 Uses

func (s CreateGrantOutput) GoString() string

GoString returns the string representation

func (*CreateGrantOutput) SetGrantId Uses

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

SetGrantId sets the GrantId field's value.

func (*CreateGrantOutput) SetGrantToken Uses

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

SetGrantToken sets the GrantToken field's value.

func (CreateGrantOutput) String Uses

func (s CreateGrantOutput) String() string

String returns the string representation

type CreateKeyInput Uses

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.
    //
    // 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"`

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

    // The cryptographic operations for which you can use the CMK. The only valid
    // value is ENCRYPT_DECRYPT, which means you can use the CMK to encrypt and
    // decrypt data.
    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 in its
    // own key store.
    //
    // 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.
    //
    // 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.
    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 limit 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. Tag keys
    // and tag values are both required, but tag values can be empty (null) strings.
    //
    // Use this parameter to tag the CMK when it is created. Alternately, you can
    // omit this parameter and instead tag the CMK after it is created using TagResource.
    Tags []*Tag `type:"list"`
    // contains filtered or unexported fields
}

func (CreateKeyInput) GoString Uses

func (s CreateKeyInput) GoString() string

GoString returns the string representation

func (*CreateKeyInput) SetBypassPolicyLockoutSafetyCheck Uses

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

SetBypassPolicyLockoutSafetyCheck sets the BypassPolicyLockoutSafetyCheck field's value.

func (*CreateKeyInput) SetCustomKeyStoreId Uses

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

SetCustomKeyStoreId sets the CustomKeyStoreId field's value.

func (*CreateKeyInput) SetDescription Uses

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

SetDescription sets the Description field's value.

func (*CreateKeyInput) SetKeyUsage Uses

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

SetKeyUsage sets the KeyUsage field's value.

func (*CreateKeyInput) SetOrigin Uses

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

SetOrigin sets the Origin field's value.

func (*CreateKeyInput) SetPolicy Uses

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

SetPolicy sets the Policy field's value.

func (*CreateKeyInput) SetTags Uses

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

SetTags sets the Tags field's value.

func (CreateKeyInput) String Uses

func (s CreateKeyInput) String() string

String returns the string representation

func (*CreateKeyInput) Validate Uses

func (s *CreateKeyInput) Validate() error

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

type CreateKeyOutput Uses

type CreateKeyOutput struct {

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

func (CreateKeyOutput) GoString Uses

func (s CreateKeyOutput) GoString() string

GoString returns the string representation

func (*CreateKeyOutput) SetKeyMetadata Uses

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

SetKeyMetadata sets the KeyMetadata field's value.

func (CreateKeyOutput) String Uses

func (s CreateKeyOutput) String() string

String returns the string representation

type CustomKeyStoresListEntry Uses

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. 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.
    //
    //    * NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting
    //    to the custom key store.
    //
    //    * 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 password value
    //    for the custom key store.
    //
    // For help with connection failures, see Troubleshooting Custom Key Stores
    // (https://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html)
    // in the AWS Key Management Service Developer Guide.
    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.
    // 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 Uses

func (s CustomKeyStoresListEntry) GoString() string

GoString returns the string representation

func (*CustomKeyStoresListEntry) SetCloudHsmClusterId Uses

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

SetCloudHsmClusterId sets the CloudHsmClusterId field's value.

func (*CustomKeyStoresListEntry) SetConnectionErrorCode Uses

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

SetConnectionErrorCode sets the ConnectionErrorCode field's value.

func (*CustomKeyStoresListEntry) SetConnectionState Uses

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

SetConnectionState sets the ConnectionState field's value.

func (*CustomKeyStoresListEntry) SetCreationDate Uses

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

SetCreationDate sets the CreationDate field's value.

func (*CustomKeyStoresListEntry) SetCustomKeyStoreId Uses

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

SetCustomKeyStoreId sets the CustomKeyStoreId field's value.

func (*CustomKeyStoresListEntry) SetCustomKeyStoreName Uses

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

SetCustomKeyStoreName sets the CustomKeyStoreName field's value.

func (*CustomKeyStoresListEntry) SetTrustAnchorCertificate Uses

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

SetTrustAnchorCertificate sets the TrustAnchorCertificate field's value.

func (CustomKeyStoresListEntry) String Uses

func (s CustomKeyStoresListEntry) String() string

String returns the string representation

type DecryptInput Uses

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"`

    // The encryption context. If this was specified in the Encrypt function, it
    // must be specified here or the decryption operation will fail. For more information,
    // see Encryption Context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context).
    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"`
    // contains filtered or unexported fields
}

func (DecryptInput) GoString Uses

func (s DecryptInput) GoString() string

GoString returns the string representation

func (*DecryptInput) SetCiphertextBlob Uses

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

SetCiphertextBlob sets the CiphertextBlob field's value.

func (*DecryptInput) SetEncryptionContext Uses

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

SetEncryptionContext sets the EncryptionContext field's value.

func (*DecryptInput) SetGrantTokens Uses

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

SetGrantTokens sets the GrantTokens field's value.

func (DecryptInput) String Uses

func (s DecryptInput) String() string

String returns the string representation

func (*DecryptInput) Validate Uses

func (s *DecryptInput) Validate() error

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

type DecryptOutput Uses

type DecryptOutput struct {

    // ARN of the key used to perform the decryption. This value is returned if
    // no errors are encountered during the operation.
    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 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 Uses

func (s DecryptOutput) GoString() string

GoString returns the string representation

func (*DecryptOutput) SetKeyId Uses

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

SetKeyId sets the KeyId field's value.

func (*DecryptOutput) SetPlaintext Uses

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

SetPlaintext sets the Plaintext field's value.

func (DecryptOutput) String Uses

func (s DecryptOutput) String() string

String returns the string representation

type DeleteAliasInput Uses

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 Uses

func (s DeleteAliasInput) GoString() string

GoString returns the string representation

func (*DeleteAliasInput) SetAliasName Uses

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

SetAliasName sets the AliasName field's value.

func (DeleteAliasInput) String Uses

func (s DeleteAliasInput) String() string

String returns the string representation

func (*DeleteAliasInput) Validate Uses

func (s *DeleteAliasInput) Validate() error

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

type DeleteAliasOutput Uses

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

func (DeleteAliasOutput) GoString Uses

func (s DeleteAliasOutput) GoString() string

GoString returns the string representation

func (DeleteAliasOutput) String Uses

func (s DeleteAliasOutput) String() string

String returns the string representation

type DeleteCustomKeyStoreInput Uses

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 Uses

func (s DeleteCustomKeyStoreInput) GoString() string

GoString returns the string representation

func (*DeleteCustomKeyStoreInput) SetCustomKeyStoreId Uses

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

SetCustomKeyStoreId sets the CustomKeyStoreId field's value.

func (DeleteCustomKeyStoreInput) String Uses

func (s DeleteCustomKeyStoreInput) String() string

String returns the string representation

func (*DeleteCustomKeyStoreInput) Validate Uses

func (s *DeleteCustomKeyStoreInput) Validate() error

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

type DeleteCustomKeyStoreOutput Uses

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

func (DeleteCustomKeyStoreOutput) GoString Uses

func (s DeleteCustomKeyStoreOutput) GoString() string

GoString returns the string representation

func (DeleteCustomKeyStoreOutput) String Uses

func (s DeleteCustomKeyStoreOutput) String() string

String returns the string representation

type DeleteImportedKeyMaterialInput Uses

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 Uses

func (s DeleteImportedKeyMaterialInput) GoString() string

GoString returns the string representation

func (*DeleteImportedKeyMaterialInput) SetKeyId Uses

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

SetKeyId sets the KeyId field's value.

func (DeleteImportedKeyMaterialInput) String Uses

func (s DeleteImportedKeyMaterialInput) String() string

String returns the string representation

func (*DeleteImportedKeyMaterialInput) Validate Uses

func (s *DeleteImportedKeyMaterialInput) Validate() error

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

type DeleteImportedKeyMaterialOutput Uses

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

func (DeleteImportedKeyMaterialOutput) GoString Uses

func (s DeleteImportedKeyMaterialOutput) GoString() string

GoString returns the string representation

func (DeleteImportedKeyMaterialOutput) String Uses

func (s DeleteImportedKeyMaterialOutput) String() string

String returns the string representation

type DescribeCustomKeyStoresInput Uses

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 Uses

func (s DescribeCustomKeyStoresInput) GoString() string

GoString returns the string representation

func (*DescribeCustomKeyStoresInput) SetCustomKeyStoreId Uses

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

SetCustomKeyStoreId sets the CustomKeyStoreId field's value.

func (*DescribeCustomKeyStoresInput) SetCustomKeyStoreName Uses

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

SetCustomKeyStoreName sets the CustomKeyStoreName field's value.

func (*DescribeCustomKeyStoresInput) SetLimit Uses

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

SetLimit sets the Limit field's value.

func (*DescribeCustomKeyStoresInput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (DescribeCustomKeyStoresInput) String Uses

func (s DescribeCustomKeyStoresInput) String() string

String returns the string representation

func (*DescribeCustomKeyStoresInput) Validate Uses

func (s *DescribeCustomKeyStoresInput) Validate() error

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

type DescribeCustomKeyStoresOutput Uses

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 Uses

func (s DescribeCustomKeyStoresOutput) GoString() string

GoString returns the string representation

func (*DescribeCustomKeyStoresOutput) SetCustomKeyStores Uses

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

SetCustomKeyStores sets the CustomKeyStores field's value.

func (*DescribeCustomKeyStoresOutput) SetNextMarker Uses

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

SetNextMarker sets the NextMarker field's value.

func (*DescribeCustomKeyStoresOutput) SetTruncated Uses

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

SetTruncated sets the Truncated field's value.

func (DescribeCustomKeyStoresOutput) String Uses

func (s DescribeCustomKeyStoresOutput) String() string

String returns the string representation

type DescribeKeyInput Uses

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 Uses

func (s DescribeKeyInput) GoString() string

GoString returns the string representation

func (*DescribeKeyInput) SetGrantTokens Uses

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

SetGrantTokens sets the GrantTokens field's value.

func (*DescribeKeyInput) SetKeyId Uses

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

SetKeyId sets the KeyId field's value.

func (DescribeKeyInput) String Uses

func (s DescribeKeyInput) String() string

String returns the string representation

func (*DescribeKeyInput) Validate Uses

func (s *DescribeKeyInput) Validate() error

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

type DescribeKeyOutput Uses

type DescribeKeyOutput struct {

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

func (DescribeKeyOutput) GoString Uses

func (s DescribeKeyOutput) GoString() string

GoString returns the string representation

func (*DescribeKeyOutput) SetKeyMetadata Uses

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

SetKeyMetadata sets the KeyMetadata field's value.

func (DescribeKeyOutput) String Uses

func (s DescribeKeyOutput) String() string

String returns the string representation

type DisableKeyInput Uses

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 Uses

func (s DisableKeyInput) GoString() string

GoString returns the string representation

func (*DisableKeyInput) SetKeyId Uses

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

SetKeyId sets the KeyId field's value.

func (DisableKeyInput) String Uses

func (s DisableKeyInput) String() string

String returns the string representation

func (*DisableKeyInput) Validate Uses

func (s *DisableKeyInput) Validate() error

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

type DisableKeyOutput Uses

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

func (DisableKeyOutput) GoString Uses

func (s DisableKeyOutput) GoString() string

GoString returns the string representation

func (DisableKeyOutput) String Uses

func (s DisableKeyOutput) String() string

String returns the string representation

type DisableKeyRotationInput Uses

type DisableKeyRotationInput 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 (DisableKeyRotationInput) GoString Uses

func (s DisableKeyRotationInput) GoString() string

GoString returns the string representation

func (*DisableKeyRotationInput) SetKeyId Uses

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

SetKeyId sets the KeyId field's value.

func (DisableKeyRotationInput) String Uses

func (s DisableKeyRotationInput) String() string

String returns the string representation

func (*DisableKeyRotationInput) Validate Uses

func (s *DisableKeyRotationInput) Validate() error

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

type DisableKeyRotationOutput Uses

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

func (DisableKeyRotationOutput) GoString Uses

func (s DisableKeyRotationOutput) GoString() string

GoString returns the string representation

func (DisableKeyRotationOutput) String Uses

func (s DisableKeyRotationOutput) String() string

String returns the string representation

type DisconnectCustomKeyStoreInput Uses

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 Uses

func (s DisconnectCustomKeyStoreInput) GoString() string

GoString returns the string representation

func (*DisconnectCustomKeyStoreInput) SetCustomKeyStoreId Uses

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

SetCustomKeyStoreId sets the CustomKeyStoreId field's value.

func (DisconnectCustomKeyStoreInput) String Uses

func (s DisconnectCustomKeyStoreInput) String() string

String returns the string representation

func (*DisconnectCustomKeyStoreInput) Validate Uses

func (s *DisconnectCustomKeyStoreInput) Validate() error

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

type DisconnectCustomKeyStoreOutput Uses

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

func (DisconnectCustomKeyStoreOutput) GoString Uses

func (s DisconnectCustomKeyStoreOutput) GoString() string

GoString returns the string representation

func (DisconnectCustomKeyStoreOutput) String Uses

func (s DisconnectCustomKeyStoreOutput) String() string

String returns the string representation

type EnableKeyInput Uses

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 Uses

func (s EnableKeyInput) GoString() string

GoString returns the string representation

func (*EnableKeyInput) SetKeyId Uses

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

SetKeyId sets the KeyId field's value.

func (EnableKeyInput) String Uses

func (s EnableKeyInput) String() string

String returns the string representation

func (*EnableKeyInput) Validate Uses

func (s *EnableKeyInput) Validate() error

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

type EnableKeyOutput Uses

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

func (EnableKeyOutput) GoString Uses

func (s EnableKeyOutput) GoString() string

GoString returns the string representation

func (EnableKeyOutput) String Uses

func (s EnableKeyOutput) String() string

String returns the string representation

type EnableKeyRotationInput Uses

type EnableKeyRotationInput 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 (EnableKeyRotationInput) GoString Uses

func (s EnableKeyRotationInput) GoString() string

GoString returns the string representation

func (*EnableKeyRotationInput) SetKeyId Uses

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

SetKeyId sets the KeyId field's value.

func (EnableKeyRotationInput) String Uses

func (s EnableKeyRotationInput) String() string

String returns the string representation

func (*EnableKeyRotationInput) Validate Uses

func (s *EnableKeyRotationInput) Validate() error

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

type EnableKeyRotationOutput Uses

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

func (EnableKeyRotationOutput) GoString Uses

func (s EnableKeyRotationOutput) GoString() string

GoString returns the string representation

func (EnableKeyRotationOutput) String Uses

func (s EnableKeyRotationOutput) String() string

String returns the string representation

type EncryptInput Uses

type EncryptInput struct {

    // Name-value pair that specifies the encryption context to be used for authenticated
    // encryption. If used here, the same value must be supplied to the Decrypt
    // API or decryption will fail. For more information, see Encryption Context
    // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context).
    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 Uses

func (s EncryptInput) GoString() string

GoString returns the string representation

func (*EncryptInput) SetEncryptionContext Uses

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

SetEncryptionContext sets the EncryptionContext field's value.

func (*EncryptInput) SetGrantTokens Uses

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

SetGrantTokens sets the GrantTokens field's value.

func (*EncryptInput) SetKeyId Uses

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

SetKeyId sets the KeyId field's value.

func (*EncryptInput) SetPlaintext Uses

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

SetPlaintext sets the Plaintext field's value.

func (EncryptInput) String Uses

func (s EncryptInput) String() string

String returns the string representation

func (*EncryptInput) Validate Uses

func (s *EncryptInput) Validate() error

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

type EncryptOutput Uses

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 encoded.
    //
    // CiphertextBlob is automatically base64 encoded/decoded by the SDK.
    CiphertextBlob []byte `min:"1" type:"blob"`

    // The ID of the key used during encryption.
    KeyId *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (EncryptOutput) GoString Uses

func (s EncryptOutput) GoString() string

GoString returns the string representation

func (*EncryptOutput) SetCiphertextBlob Uses

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

SetCiphertextBlob sets the CiphertextBlob field's value.

func (*EncryptOutput) SetKeyId Uses

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

SetKeyId sets the KeyId field's value.

func (EncryptOutput) String Uses

func (s EncryptOutput) String() string

String returns the string representation

type GenerateDataKeyInput Uses

type GenerateDataKeyInput struct {

    // A set of key-value pairs that represents additional authenticated data.
    //
    // 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"`

    // An identifier for the 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 (GenerateDataKeyInput) GoString Uses

func (s GenerateDataKeyInput) GoString() string

GoString returns the string representation

func (*GenerateDataKeyInput) SetEncryptionContext Uses

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

SetEncryptionContext sets the EncryptionContext field's value.

func (*GenerateDataKeyInput) SetGrantTokens Uses

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

SetGrantTokens sets the GrantTokens field's value.

func (*GenerateDataKeyInput) SetKeyId Uses

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

SetKeyId sets the KeyId field's value.

func (*GenerateDataKeyInput) SetKeySpec Uses

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

SetKeySpec sets the KeySpec field's value.

func (*GenerateDataKeyInput) SetNumberOfBytes Uses

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

SetNumberOfBytes sets the NumberOfBytes field's value.

func (GenerateDataKeyInput) String Uses

func (s GenerateDataKeyInput) String() string

String returns the string representation

func (*GenerateDataKeyInput) Validate Uses

func (s *GenerateDataKeyInput) Validate() error

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

type GenerateDataKeyOutput Uses

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 encoded.
    //
    // CiphertextBlob is automatically base64 encoded/decoded by the SDK.
    CiphertextBlob []byte `min:"1" type:"blob"`

    // The identifier 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 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 Uses

func (s GenerateDataKeyOutput) GoString() string

GoString returns the string representation

func (*GenerateDataKeyOutput) SetCiphertextBlob Uses

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

SetCiphertextBlob sets the CiphertextBlob field's value.

func (*GenerateDataKeyOutput) SetKeyId Uses

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

SetKeyId sets the KeyId field's value.

func (*GenerateDataKeyOutput) SetPlaintext Uses

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

SetPlaintext sets the Plaintext field's value.

func (GenerateDataKeyOutput) String Uses

func (s GenerateDataKeyOutput) String() string

String returns the string representation

type GenerateDataKeyWithoutPlaintextInput Uses

type GenerateDataKeyWithoutPlaintextInput struct {

    // A set of key-value pairs that represents additional authenticated data.
    //
    // 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 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 Uses

func (s GenerateDataKeyWithoutPlaintextInput) GoString() string

GoString returns the string representation

func (*GenerateDataKeyWithoutPlaintextInput) SetEncryptionContext Uses

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

SetEncryptionContext sets the EncryptionContext field's value.

func (*GenerateDataKeyWithoutPlaintextInput) SetGrantTokens Uses

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

SetGrantTokens sets the GrantTokens field's value.

func (*GenerateDataKeyWithoutPlaintextInput) SetKeyId Uses

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

SetKeyId sets the KeyId field's value.

func (*GenerateDataKeyWithoutPlaintextInput) SetKeySpec Uses

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

SetKeySpec sets the KeySpec field's value.

func (*GenerateDataKeyWithoutPlaintextInput) SetNumberOfBytes Uses

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

SetNumberOfBytes sets the NumberOfBytes field's value.

func (GenerateDataKeyWithoutPlaintextInput) String Uses

func (s GenerateDataKeyWithoutPlaintextInput) String() string

String returns the string representation

func (*GenerateDataKeyWithoutPlaintextInput) Validate Uses

func (s *GenerateDataKeyWithoutPlaintextInput) Validate() error

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

type GenerateDataKeyWithoutPlaintextOutput Uses

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 encoded.
    //
    // CiphertextBlob is automatically base64 encoded/decoded by the SDK.
    CiphertextBlob []byte `min:"1" type:"blob"`

    // The identifier of the CMK that encrypted the data key.
    KeyId *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (GenerateDataKeyWithoutPlaintextOutput) GoString Uses

func (s GenerateDataKeyWithoutPlaintextOutput) GoString() string

GoString returns the string representation

func (*GenerateDataKeyWithoutPlaintextOutput) SetCiphertextBlob Uses

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

SetCiphertextBlob sets the CiphertextBlob field's value.

func (*GenerateDataKeyWithoutPlaintextOutput) SetKeyId Uses

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

SetKeyId sets the KeyId field's value.

func (GenerateDataKeyWithoutPlaintextOutput) String Uses

func (s GenerateDataKeyWithoutPlaintextOutput) String() string

String returns the string representation

type GenerateRandomInput Uses

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 Uses

func (s GenerateRandomInput) GoString() string

GoString returns the string representation

func (*GenerateRandomInput) SetCustomKeyStoreId Uses

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

SetCustomKeyStoreId sets the CustomKeyStoreId field's value.

func (*GenerateRandomInput) SetNumberOfBytes Uses

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

SetNumberOfBytes sets the NumberOfBytes field's value.

func (GenerateRandomInput) String Uses

func (s GenerateRandomInput) String() string

String returns the string representation

func (*GenerateRandomInput) Validate Uses

func (s *GenerateRandomInput) Validate() error

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

type GenerateRandomOutput Uses

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 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 Uses

func (s GenerateRandomOutput) GoString() string

GoString returns the string representation

func (*GenerateRandomOutput) SetPlaintext Uses

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

SetPlaintext sets the Plaintext field's value.

func (GenerateRandomOutput) String Uses

func (s GenerateRandomOutput) String() string

String returns the string representation

type GetKeyPolicyInput Uses

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 Uses

func (s GetKeyPolicyInput) GoString() string

GoString returns the string representation

func (*GetKeyPolicyInput) SetKeyId Uses

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

SetKeyId sets the KeyId field's value.

func (*GetKeyPolicyInput) SetPolicyName Uses

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

SetPolicyName sets the PolicyName field's value.

func (GetKeyPolicyInput) String Uses

func (s GetKeyPolicyInput) String() string

String returns the string representation

func (*GetKeyPolicyInput) Validate Uses

func (s *GetKeyPolicyInput) Validate() error

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

type GetKeyPolicyOutput Uses

type GetKeyPolicyOutput struct {

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

func (GetKeyPolicyOutput) GoString Uses

func (s GetKeyPolicyOutput) GoString() string

GoString returns the string representation

func (*GetKeyPolicyOutput) SetPolicy Uses

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

SetPolicy sets the Policy field's value.

func (GetKeyPolicyOutput) String Uses

func (s GetKeyPolicyOutput) String() string

String returns the string representation

type GetKeyRotationStatusInput Uses

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 Uses

func (s GetKeyRotationStatusInput) GoString() string

GoString returns the string representation

func (*GetKeyRotationStatusInput) SetKeyId Uses

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

SetKeyId sets the KeyId field's value.

func (GetKeyRotationStatusInput) String Uses

func (s GetKeyRotationStatusInput) String() string

String returns the string representation

func (*GetKeyRotationStatusInput) Validate Uses

func (s *GetKeyRotationStatusInput) Validate() error

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

type GetKeyRotationStatusOutput Uses

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 Uses

func (s GetKeyRotationStatusOutput) GoString() string

GoString returns the string representation

func (*GetKeyRotationStatusOutput) SetKeyRotationEnabled Uses

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

SetKeyRotationEnabled sets the KeyRotationEnabled field's value.

func (GetKeyRotationStatusOutput) String Uses

func (s GetKeyRotationStatusOutput) String() string

String returns the string representation

type GetParametersForImportInput Uses

type GetParametersForImportInput struct {

    // The identifier of the CMK into which you will import key material. The CMK's
    // Origin 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 Uses

func (s GetParametersForImportInput) GoString() string

GoString returns the string representation

func (*GetParametersForImportInput) SetKeyId Uses

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

SetKeyId sets the KeyId field's value.

func (*GetParametersForImportInput) SetWrappingAlgorithm Uses

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

SetWrappingAlgorithm sets the WrappingAlgorithm field's value.

func (*GetParametersForImportInput) SetWrappingKeySpec Uses

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

SetWrappingKeySpec sets the WrappingKeySpec field's value.

func (GetParametersForImportInput) String Uses

func (s GetParametersForImportInput) String() string

String returns the string representation

func (*GetParametersForImportInput) Validate Uses

func (s *GetParametersForImportInput) Validate() error

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

type GetParametersForImportOutput Uses

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 identifier 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 Uses

func (s GetParametersForImportOutput) GoString() string

GoString returns the string representation

func (*GetParametersForImportOutput) SetImportToken Uses

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

SetImportToken sets the ImportToken field's value.

func (*GetParametersForImportOutput) SetKeyId Uses

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

SetKeyId sets the KeyId field's value.

func (*GetParametersForImportOutput) SetParametersValidTo Uses

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

SetParametersValidTo sets the ParametersValidTo field's value.

func (*GetParametersForImportOutput) SetPublicKey Uses

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

SetPublicKey sets the PublicKey field's value.

func (GetParametersForImportOutput) String Uses

func (s GetParametersForImportOutput) String() string

String returns the string representation

type GrantConstraints Uses

type GrantConstraints struct {

    // A list of key-value pairs that must match the encryption context in the cryptographic
    // operation 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 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 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 when the grant allows a cryptographic operation that accepts an encryption context as input, such as the following.

* Encrypt

* Decrypt

* GenerateDataKey

* GenerateDataKeyWithoutPlaintext

* ReEncrypt

AWS KMS does not apply the grant constraints to other 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 Uses

func (s GrantConstraints) GoString() string

GoString returns the string representation

func (*GrantConstraints) SetEncryptionContextEquals Uses

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

SetEncryptionContextEquals sets the EncryptionContextEquals field's value.

func (*GrantConstraints) SetEncryptionContextSubset Uses

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

SetEncryptionContextSubset sets the EncryptionContextSubset field's value.

func (GrantConstraints) String Uses

func (s GrantConstraints) String() string

String returns the string representation

type GrantListEntry Uses

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 principal that receives the grant's permissions.
    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 an entry in a list of grants.

func (GrantListEntry) GoString Uses

func (s GrantListEntry) GoString() string

GoString returns the string representation

func (*GrantListEntry) SetConstraints Uses

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

SetConstraints sets the Constraints field's value.

func (*GrantListEntry) SetCreationDate Uses

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

SetCreationDate sets the CreationDate field's value.

func (*GrantListEntry) SetGrantId Uses

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

SetGrantId sets the GrantId field's value.

func (*GrantListEntry) SetGranteePrincipal Uses

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

SetGranteePrincipal sets the GranteePrincipal field's value.

func (*GrantListEntry) SetIssuingAccount Uses

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

SetIssuingAccount sets the IssuingAccount field's value.

func (*GrantListEntry) SetKeyId Uses

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

SetKeyId sets the KeyId field's value.

func (*GrantListEntry) SetName Uses

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

SetName sets the Name field's value.

func (*GrantListEntry) SetOperations Uses

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

SetOperations sets the Operations field's value.

func (*GrantListEntry) SetRetiringPrincipal Uses

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

SetRetiringPrincipal sets the RetiringPrincipal field's value.

func (GrantListEntry) String Uses

func (s GrantListEntry) String() string

String returns the string representation

type ImportKeyMaterialInput Uses

type ImportKeyMaterialInput struct {

    // The encrypted key material to import. It must be encrypted with the public
    // key that you received in the response to a previous GetParametersForImport
    // request, using the wrapping algorithm that you specified in that 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 CMK to import the key material into. The CMK's Origin
    // 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 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 Uses

func (s ImportKeyMaterialInput) GoString() string

GoString returns the string representation

func (*ImportKeyMaterialInput) SetEncryptedKeyMaterial Uses

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

SetEncryptedKeyMaterial sets the EncryptedKeyMaterial field's value.

func (*ImportKeyMaterialInput) SetExpirationModel Uses

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

SetExpirationModel sets the ExpirationModel field's value.

func (*ImportKeyMaterialInput) SetImportToken Uses

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

SetImportToken sets the ImportToken field's value.

func (*ImportKeyMaterialInput) SetKeyId Uses

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

SetKeyId sets the KeyId field's value.

func (*ImportKeyMaterialInput) SetValidTo Uses

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

SetValidTo sets the ValidTo field's value.

func (ImportKeyMaterialInput) String Uses

func (s ImportKeyMaterialInput) String() string

String returns the string representation

func (*ImportKeyMaterialInput) Validate Uses

func (s *ImportKeyMaterialInput) Validate() error

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

type ImportKeyMaterialOutput Uses

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

func (ImportKeyMaterialOutput) GoString Uses

func (s ImportKeyMaterialOutput) GoString() string

GoString returns the string representation

func (ImportKeyMaterialOutput) String Uses

func (s ImportKeyMaterialOutput) String() string

String returns the string representation

type KMS Uses

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 Uses

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:

// 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 Uses

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 is successful, the CMK is set to the Disabled state. To enable a 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 result of this operation varies with the key state of the CMK. 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 Codes:

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

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

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

* ErrCodeInternalException "KMSInternalException"
The request was rejected because an internal exception occurred. The request
can be retried.

* ErrCodeInvalidStateException "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.

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

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 Uses

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 Uses

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 Uses

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.

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 crypto user (https://docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-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 Codes:

* ErrCodeCloudHsmClusterNotActiveException "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.

* ErrCodeCustomKeyStoreInvalidStateException "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.

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

* ErrCodeInternalException "KMSInternalException"
The request was rejected because an internal exception occurred. The request
can be retried.

* ErrCodeCloudHsmClusterInvalidConfigurationException "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 Uses

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 Uses

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 Uses

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 selected operations, such as Encrypt and GenerateDataKey.

Each CMK can have multiple aliases, but each alias points to only one CMK. The alias name must be unique in the AWS account and region. To simplify code that runs in multiple regions, use the same alias name, but point it to a different CMK in each region.

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.

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 and the CMK it is mapped to must be in the same AWS account and the same region. You cannot perform this operation on an alias in a different AWS account.

To map an existing alias to a different CMK, call UpdateAlias.

The result of this operation varies with the key state of the CMK. 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 Codes:

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

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

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

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

* ErrCodeInternalException "KMSInternalException"
The request was rejected because an internal exception occurred. The request
can be retried.

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

* ErrCodeInvalidStateException "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.

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

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 Uses

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 Uses

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 Uses

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 Codes:

* ErrCodeCloudHsmClusterInUseException "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.

* ErrCodeCustomKeyStoreNameInUseException "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.

* ErrCodeCloudHsmClusterNotFoundException "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.

* ErrCodeInternalException "KMSInternalException"
The request was rejected because an internal exception occurred. The request
can be retried.

* ErrCodeCloudHsmClusterNotActiveException "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.

* ErrCodeIncorrectTrustAnchorException "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.

* ErrCodeCloudHsmClusterInvalidConfigurationException "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 Uses

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 Uses

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 Uses

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 only when the encryption context in the operation request matches or includes a specified encryption context, use the Constraints parameter. For details, see GrantConstraints.

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 result of this operation varies with the key state of the CMK. 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 Codes:

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

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

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

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

* ErrCodeInternalException "KMSInternalException"
The request was rejected because an internal exception occurred. The request
can be retried.

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

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

* ErrCodeInvalidStateException "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.

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

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 Uses

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 Uses

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 Uses

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

CreateKey API operation for AWS Key Management Service.

Creates a customer managed customer master key (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys) (CMK) in your AWS account.

You can use a CMK to encrypt small amounts of data (up to 4096 bytes) directly. But CMKs are more commonly used to encrypt the data keys (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys) that are used to encrypt data.

To create a CMK for imported key material, use the Origin parameter with a value of EXTERNAL.

To create a 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 use this operation to create 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 CreateKey for usage and error information.

Returned Error Codes:

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

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

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

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

* ErrCodeInternalException "KMSInternalException"
The request was rejected because an internal exception occurred. The request
can be retried.

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

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

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

* ErrCodeCustomKeyStoreInvalidStateException "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.

* ErrCodeCloudHsmClusterInvalidConfigurationException "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

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 Uses

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 Uses

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 Uses

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

Decrypt API operation for AWS Key Management Service.

Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using any of the following operations:

* GenerateDataKey

* GenerateDataKeyWithoutPlaintext

* Encrypt

Whenever possible, use key policies to give users permission to call the Decrypt operation on the CMK, instead of 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 result of this operation varies with the key state of the CMK. 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 Codes:

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

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

* ErrCodeInvalidCiphertextException "InvalidCiphertextException"
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.

* ErrCodeKeyUnavailableException "KeyUnavailableException"
The request was rejected because the specified CMK was not available. The
request can be retried.

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

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

* ErrCodeInternalException "KMSInternalException"
The request was rejected because an internal exception occurred. The request
can be retried.

* ErrCodeInvalidStateException "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.

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

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.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 Uses

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 Uses

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 Uses

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 Codes:

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

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

* ErrCodeInternalException "KMSInternalException"
The request was rejected because an internal exception occurred. The request
can be retried.

* ErrCodeInvalidStateException "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.

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

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 Uses

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 Uses

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 Uses

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. 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 Codes:

* ErrCodeCustomKeyStoreHasCMKsException "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.

* ErrCodeCustomKeyStoreInvalidStateException "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.

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

* ErrCodeInternalException "KMSInternalException"
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 Uses

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 Uses

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 Uses

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 result of this operation varies with the key state of the CMK. 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 Codes:

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

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

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

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

* ErrCodeInternalException "KMSInternalException"
The request was rejected because an internal exception occurred. The request
can be retried.

* ErrCodeInvalidStateException "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.

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

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 Uses

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 Uses

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 Uses

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 Codes:

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

* ErrCodeInternalException "KMSInternalException"
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 Uses

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 Uses

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 Uses

func (c *KMS) DescribeKey(input *DescribeKeyInput) (*DescribeKeyOutput, error)

DescribeKey API operation for AWS Key Management Service.

Provides detailed information about the specified customer master key (CMK).

You can use DescribeKey on a predefined AWS alias, that is, an AWS alias with no key ID. When you do, AWS 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 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 Codes:

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

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

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

* ErrCodeInternalException "KMSInternalException"
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

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 Uses

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 Uses

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 Uses

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. 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 result of this operation varies with the key state of the CMK. 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 Codes:

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

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

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

* ErrCodeInternalException "KMSInternalException"
The request was rejected because an internal exception occurred. The request
can be retried.

* ErrCodeInvalidStateException "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.

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

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 Uses

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 Uses

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 customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.

The result of this operation varies with the key state of the CMK. 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 Codes:

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

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

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

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

* ErrCodeInternalException "KMSInternalException"
The request was rejected because an internal exception occurred. The request
can be retried.

* ErrCodeInvalidStateException "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.

* ErrCodeUnsupportedOperationException "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

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 Uses

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 Uses

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 Uses

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 Uses

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 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 Codes:

* ErrCodeCustomKeyStoreInvalidStateException "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.

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

* ErrCodeInternalException "KMSInternalException"
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 Uses

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 Uses

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 Uses

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. You cannot perform this operation on a CMK in a different AWS account.

The result of this operation varies with the key state of the CMK. 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 Codes:

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

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

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

* ErrCodeInternalException "KMSInternalException"
The request was rejected because an internal exception occurred. The request
can be retried.

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

* ErrCodeInvalidStateException "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.

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

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 Uses

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 Uses

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 customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.

You cannot enable automatic rotation of 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 result of this operation varies with the key state of the CMK. 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 Codes:

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

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

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

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

* ErrCodeInternalException "KMSInternalException"
The request was rejected because an internal exception occurred. The request
can be retried.

* ErrCodeInvalidStateException "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.

* ErrCodeUnsupportedOperationException "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

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 Uses

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 Uses

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 Uses

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 Uses

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 up to 4 kilobytes (4096 bytes) of arbitrary data such
as an RSA key, a database password, or other sensitive information.

* You can use the Encrypt operation to move encrypted data from one AWS
region to another. In the first region, generate a data key and use the
plaintext key to encrypt the data. Then, in the new region, call the Encrypt
method on same plaintext data key. Now, you can safely move the encrypted
data and encrypted data key to the new region, and decrypt in the new
region when necessary.

You don't need use this operation to encrypt a data key within a region. The GenerateDataKey and GenerateDataKeyWithoutPlaintext operations return an encrypted data key.

Also, you don't need to use this operation to encrypt data in your application. You can use the plaintext and encrypted data keys that the GenerateDataKey operation returns.

The result of this operation varies with the key state of the CMK. 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 Codes:

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

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

* ErrCodeKeyUnavailableException "KeyUnavailableException"
The request was rejected because the specified CMK was not available. The
request can be retried.

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

* ErrCodeInvalidKeyUsageException "InvalidKeyUsageException"
The request was rejected because the specified KeySpec value is not valid.

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

* ErrCodeInternalException "KMSInternalException"
The request was rejected because an internal exception occurred. The request
can be retried.

* ErrCodeInvalidStateException "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.

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

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 Uses

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 Uses

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 Uses

func (c *KMS) GenerateDataKey(input *GenerateDataKeyInput) (*GenerateDataKeyOutput, error)

GenerateDataKey API operation for AWS Key Management Service.

Generates a unique data key. 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 KMS and store the encrypted data key with the encrypted data.

GenerateDataKey returns a unique data key for each request. The bytes in the key are not related to the caller or CMK that is used to encrypt the data key.

To generate a data key, you need to specify the customer master key (CMK) that will be used to encrypt the data key. You must also specify the length of the data key using either the KeySpec or NumberOfBytes field (but not both). For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use KeySpec. 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.

You will find the plaintext copy of the data key in the Plaintext field of the response, and the encrypted copy of the data key in the CiphertextBlob field.

We recommend that you use the following pattern to encrypt data locally in your application:

Use the GenerateDataKey operation to get a data encryption key.

Use the plaintext data key (returned in the Plaintext field of the response) to encrypt data locally, then erase the plaintext data key from memory.

Store the encrypted data key (returned in the CiphertextBlob field of the response) alongside the locally encrypted data.

To decrypt data locally:

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 locally, then erase the plaintext data key from memory.

To get only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To get a cryptographically secure random byte string, use GenerateRandom.

You can use the optional encryption context to add additional security to your encryption operation. When you specify an EncryptionContext in the GenerateDataKey operation, you must specify the same encryption context (a case-sensitive exact match) in your request to Decrypt the 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 result of this operation varies with the key state of the CMK. 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 GenerateDataKey for usage and error information.

Returned Error Codes:

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

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

* ErrCodeKeyUnavailableException "KeyUnavailableException"
The request was rejected because the specified CMK was not available. The
request can be retried.

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

* ErrCodeInvalidKeyUsageException "InvalidKeyUsageException"
The request was rejected because the specified KeySpec value is not valid.

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

* ErrCodeInternalException "KMSInternalException"
The request was rejected because an internal exception occurred. The request
can be retried.

* ErrCodeInvalidStateException "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.

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

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) GenerateDataKeyRequest Uses

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 Uses

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 Uses

func (c *KMS) GenerateDataKeyWithoutPlaintext(input *GenerateDataKeyWithoutPlaintextInput) (*GenerateDataKeyWithoutPlaintextOutput, error)

GenerateDataKeyWithoutPlaintext API operation for AWS Key Management Service.

Generates a unique data key. This operation returns a data key that is encrypted under a customer master key (CMK) that you specify. GenerateDataKeyWithoutPlaintext is identical to GenerateDataKey except that returns only the encrypted copy of the data key.

Like GenerateDataKey, GenerateDataKeyWithoutPlaintext returns a unique data key for each request. The bytes in the key are not related to the caller or CMK that is used to encrypt 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.

The result of this operation varies with the key state of the CMK. 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 Codes:

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

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

* ErrCodeKeyUnavailableException "KeyUnavailableException"
The request was rejected because the specified CMK was not available. The
request can be retried.

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

* ErrCodeInvalidKeyUsageException "InvalidKeyUsageException"
The request was rejected because the specified KeySpec value is not valid.

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

* ErrCodeInternalException "KMSInternalException"
The request was rejected because an internal exception occurred. The request
can be retried.

* ErrCodeInvalidStateException "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.

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

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 Uses

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 Uses

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 Uses

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 Codes:

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

* ErrCodeInternalException "KMSInternalException"
The request was rejected because an internal exception occurred. The request
can be retried.

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

* ErrCodeCustomKeyStoreInvalidStateException "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

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 Uses

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 Uses

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 Uses

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 Codes:

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

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

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

* ErrCodeInternalException "KMSInternalException"
The request was rejected because an internal exception occurred. The request
can be retried.

* ErrCodeInvalidStateException "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.

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

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 Uses

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 Uses

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 Uses

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).

The result of this operation varies with the key state of the CMK. 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 Codes:

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

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

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

* ErrCodeInternalException "KMSInternalException"
The request was rejected because an internal exception occurred. The request
can be retried.

* ErrCodeInvalidStateException "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.

* ErrCodeUnsupportedOperationException "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

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 Uses

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 Uses

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 Uses

func (c *KMS) GetParametersForImport(input *GetParametersForImportInput) (*GetParametersForImportOutput, error)

GetParametersForImport API operation for AWS Key Management Service.

Returns the items you need in order to import key material into AWS KMS 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.

You must specify the key ID of the customer master key (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 a CMK in a different AWS account.

This operation returns a public key and an import token. Use the public key to encrypt the key material. Store the import token to send with a subsequent ImportKeyMaterial request. The public key and import token from the same response must be used together. These items are valid for 24 hours. When they expire, they cannot be used for a subsequent ImportKeyMaterial request. To get new ones, send another GetParametersForImport request.

The result of this operation varies with the key state of the CMK. 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 Codes:

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

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

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

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

* ErrCodeInternalException "KMSInternalException"
The request was rejected because an internal exception occurred. The request
can be retried.

* ErrCodeInvalidStateException "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.

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

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 Uses

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 Uses

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) ImportKeyMaterial Uses

func (c *KMS) ImportKeyMaterial(input *ImportKeyMaterialInput) (*ImportKeyMaterialOutput, error)

ImportKeyMaterial API operation for AWS Key Management Service.

Imports key material into an existing AWS KMS customer master key (CMK) that was created without key material. You cannot perform this operation on a 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. This token and
the public key used to encrypt the key material must have come from the
same response.

* Whether the key material expires and if so, when. If you set an expiration
date, you can change it only by reimporting the same key material and
specifying a new expiration date. If the key material expires, AWS KMS
deletes the key material and the CMK becomes unusable. To use the CMK
again, you must reimport the same key material.

When this operation is successful, the key state of the CMK changes from PendingImport to Enabled, and you can use the CMK. After you successfully import key material into a CMK, you can reimport the same key material into that CMK, but you cannot import different key material.

The result of this operation varies with the key state of the CMK. 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 Codes:

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

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

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

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

* ErrCodeInternalException "KMSInternalException"
The request was rejected because an internal exception occurred. The request
can be retried.

* ErrCodeInvalidStateException "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.

* ErrCodeInvalidCiphertextException "InvalidCiphertextException"
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.

* ErrCodeIncorrectKeyMaterialException "IncorrectKeyMaterialException"
The request was rejected because the provided key material is invalid or
is not the same key material that was previously imported into this customer
master key (CMK).

* ErrCodeExpiredImportTokenException "ExpiredImportTokenException"
The request was rejected because the provided 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.

* ErrCodeInvalidImportTokenException "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

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 Uses

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 Uses

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 Uses

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 limit (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 Codes:

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

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

* ErrCodeInternalException "KMSInternalException"
The request was rejected because an internal exception occurred. The request
can be retried.

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

* ErrCodeNotFoundException "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

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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.

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 Codes:

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

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

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

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

* ErrCodeInternalException "KMSInternalException"
The request was rejected because an internal exception occurred. The request
can be retried.

* ErrCodeInvalidStateException "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.

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

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Codes:

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

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

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

* ErrCodeInternalException "KMSInternalException"
The request was rejected because an internal exception occurred. The request
can be retried.

* ErrCodeInvalidStateException "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.

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

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Codes:

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

* ErrCodeInternalException "KMSInternalException"
The request was rejected because an internal exception occurred. The request
can be retried.

* ErrCodeInvalidMarkerException "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

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Codes:

* ErrCodeInternalException "KMSInternalException"
The request was rejected because an internal exception occurred. The request
can be retried.

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

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

* ErrCodeInvalidMarkerException "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

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 Uses

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 Uses

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 Uses

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 Codes:

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

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

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

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

* ErrCodeInternalException "KMSInternalException"
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

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 Uses

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 Uses

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 Uses

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 Codes:

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

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

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

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

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

* ErrCodeInternalException "KMSInternalException"
The request was rejected because an internal exception occurred. The request
can be retried.

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

* ErrCodeInvalidStateException "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.

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

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 Uses

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 Uses

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 Uses

func (c *KMS) ReEncrypt(input *ReEncryptInput) (*ReEncryptOutput, error)

ReEncrypt API operation for AWS Key Management Service.

Encrypts data on the server side with a new customer master key (CMK) without exposing the plaintext of the data on the client side. The data is first decrypted and then reencrypted. You can also use this operation to change the encryption context of a ciphertext.

You can reencrypt data using CMKs in different AWS accounts.

Unlike other operations, ReEncrypt is authorized twice, once as ReEncryptFrom on the source CMK and once as ReEncryptTo on the destination CMK. We recommend that you include the "kms:ReEncrypt*" permission in your key policies (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html) to permit reencryption from or to the CMK. This permission is automatically included in the key policy when you create a CMK through the console. But you must include it manually when you create a CMK programmatically or when you set a key policy with the PutKeyPolicy operation.

The result of this operation varies with the key state of the CMK. 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 Codes:

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

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

* ErrCodeInvalidCiphertextException "InvalidCiphertextException"
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.

* ErrCodeKeyUnavailableException "KeyUnavailableException"
The request was rejected because the specified CMK was not available. The
request can be retried.

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

* ErrCodeInvalidKeyUsageException "InvalidKeyUsageException"
The request was rejected because the specified KeySpec value is not valid.

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

* ErrCodeInternalException "KMSInternalException"
The request was rejected because an internal exception occurred. The request
can be retried.

* ErrCodeInvalidStateException "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.

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

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.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 Uses

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 Uses

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 Uses

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 Codes:

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

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

* ErrCodeInvalidGrantIdException "InvalidGrantIdException"
The request was rejected because the specified GrantId is not valid.

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

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

* ErrCodeInternalException "KMSInternalException"
The request was rejected because an internal exception occurred. The request
can be retried.

* ErrCodeInvalidStateException "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.

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

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 Uses

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 Uses

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 Uses

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 Codes:

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

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

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

* ErrCodeInvalidGrantIdException "InvalidGrantIdException"
The request was rejected because the specified GrantId is not valid.

* ErrCodeInternalException "KMSInternalException"
The request was rejected because an internal exception occurred. The request
can be retried.

* ErrCodeInvalidStateException "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.

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

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 Uses

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 Uses

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 Uses

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 result of this operation varies with the key state of the CMK. 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 Codes:

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

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

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

* ErrCodeInternalException "KMSInternalException"
The request was rejected because an internal exception occurred. The request
can be retried.

* ErrCodeInvalidStateException "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.

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

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 Uses

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 Uses

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) TagResource Uses

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 result of this operation varies with the key state of the CMK. 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 Codes:

* ErrCodeInternalException "KMSInternalException"
The request was rejected because an internal exception occurred. The request
can be retried.

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

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

* ErrCodeInvalidStateException "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.

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

* ErrCodeTagException "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

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 Uses

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 Uses

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 Uses

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 result of this operation varies with the key state of the CMK. 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 Codes:

* ErrCodeInternalException "KMSInternalException"
The request was rejected because an internal exception occurred. The request
can be retried.

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

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

* ErrCodeInvalidStateException "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.

* ErrCodeTagException "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

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 Uses

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 Uses

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 Uses

func (c *KMS) UpdateAlias(input *UpdateAliasInput) (*UpdateAliasOutput, error)

UpdateAlias API operation for AWS Key Management Service.

Associates an existing alias with a different customer master key (CMK). Each CMK can have multiple aliases, but the aliases must be unique within the account and region. You cannot perform this operation on an alias in a different AWS account.

This operation works only on existing aliases. To change the alias of a CMK to a new value, use CreateAlias to create a new alias and DeleteAlias to delete the old 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 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 result of this operation varies with the key state of the CMK. 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 Codes:

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

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

* ErrCodeInternalException "KMSInternalException"
The request was rejected because an internal exception occurred. The request
can be retried.

* ErrCodeInvalidStateException "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.

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

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.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 Uses

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 Uses

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 Uses

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 Codes:

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

* ErrCodeCloudHsmClusterNotFoundException "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.

* ErrCodeCloudHsmClusterNotRelatedException "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.

* ErrCodeCustomKeyStoreInvalidStateException "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.

* ErrCodeInternalException "KMSInternalException"
The request was rejected because an internal exception occurred. The request
can be retried.

* ErrCodeCloudHsmClusterNotActiveException "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.

* ErrCodeCloudHsmClusterInvalidConfigurationException "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 Uses

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 Uses

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 Uses

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 result of this operation varies with the key state of the CMK. 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 Codes:

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

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

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

* ErrCodeInternalException "KMSInternalException"
The request was rejected because an internal exception occurred. The request
can be retried.

* ErrCodeInvalidStateException "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.

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

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 Uses

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 Uses

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.

type KeyListEntry Uses

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 Uses

func (s KeyListEntry) GoString() string

GoString returns the string representation

func (*KeyListEntry) SetKeyArn Uses

func (s *KeyListEntry) SetKeyArn(v string) *KeyListEntry

SetKeyArn sets the KeyArn field's value.

func (*KeyListEntry) SetKeyId Uses

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

SetKeyId sets the KeyId field's value.

func (KeyListEntry) String Uses

func (s KeyListEntry) String() string

String returns the string representation

type KeyMetadata Uses

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"`

    // 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"`

    // 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 state of the CMK.
    //
    // 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.
    KeyState *string `type:"string" enum:"KeyState"`

    // The cryptographic operations for which you can use the CMK. The only valid
    // value is ENCRYPT_DECRYPT, which means you can use the CMK to encrypt and
    // decrypt data.
    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 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 Uses

func (s KeyMetadata) GoString() string

GoString returns the string representation

func (*KeyMetadata) SetAWSAccountId Uses

func (s *KeyMetadata) SetAWSAccountId(v string) *KeyMetadata

SetAWSAccountId sets the AWSAccountId field's value.

func (*KeyMetadata) SetArn Uses

func (s *KeyMetadata) SetArn(v string) *KeyMetadata

SetArn sets the Arn field's value.

func (*KeyMetadata) SetCloudHsmClusterId Uses

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

SetCloudHsmClusterId sets the CloudHsmClusterId field's value.

func (*KeyMetadata) SetCreationDate Uses

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

SetCreationDate sets the CreationDate field's value.

func (*KeyMetadata) SetCustomKeyStoreId Uses

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

SetCustomKeyStoreId sets the CustomKeyStoreId field's value.

func (*KeyMetadata) SetDeletionDate Uses

func (s *KeyMetadata) SetDeletionDate(v time.Time) *KeyMetadata

SetDeletionDate sets the DeletionDate field's value.

func (*KeyMetadata) SetDescription Uses

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

SetDescription sets the Description field's value.

func (*KeyMetadata) SetEnabled Uses

func (s *KeyMetadata) SetEnabled(v bool) *KeyMetadata

SetEnabled sets the Enabled field's value.

func (*KeyMetadata) SetExpirationModel Uses

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

SetExpirationModel sets the ExpirationModel field's value.

func (*KeyMetadata) SetKeyId Uses

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

SetKeyId sets the KeyId field's value.

func (*KeyMetadata) SetKeyManager Uses

func (s *KeyMetadata) SetKeyManager(v string) *KeyMetadata

SetKeyManager sets the KeyManager field's value.

func (*KeyMetadata) SetKeyState Uses

func (s *KeyMetadata) SetKeyState(v string) *KeyMetadata

SetKeyState sets the KeyState field's value.

func (*KeyMetadata) SetKeyUsage Uses

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

SetKeyUsage sets the KeyUsage field's value.

func (*KeyMetadata) SetOrigin Uses

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

SetOrigin sets the Origin field's value.

func (*KeyMetadata) SetValidTo Uses

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

SetValidTo sets the ValidTo field's value.

func (KeyMetadata) String Uses

func (s KeyMetadata) String() string

String returns the string representation

type ListAliasesInput Uses

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 Uses

func (s ListAliasesInput) GoString() string

GoString returns the string representation

func (*ListAliasesInput) SetKeyId Uses

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

SetKeyId sets the KeyId field's value.

func (*ListAliasesInput) SetLimit Uses

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

SetLimit sets the Limit field's value.

func (*ListAliasesInput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (ListAliasesInput) String Uses

func (s ListAliasesInput) String() string

String returns the string representation

func (*ListAliasesInput) Validate Uses

func (s *ListAliasesInput) Validate() error

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

type ListAliasesOutput Uses

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 Uses

func (s ListAliasesOutput) GoString() string

GoString returns the string representation

func (*ListAliasesOutput) SetAliases Uses

func (s *ListAliasesOutput) SetAliases(v []*AliasListEntry) *ListAliasesOutput

SetAliases sets the Aliases field's value.

func (*ListAliasesOutput) SetNextMarker Uses

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

SetNextMarker sets the NextMarker field's value.

func (*ListAliasesOutput) SetTruncated Uses

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

SetTruncated sets the Truncated field's value.

func (ListAliasesOutput) String Uses

func (s ListAliasesOutput) String() string

String returns the string representation

type ListGrantsInput Uses

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 Uses

func (s ListGrantsInput) GoString() string

GoString returns the string representation

func (*ListGrantsInput) SetKeyId Uses

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

SetKeyId sets the KeyId field's value.

func (*ListGrantsInput) SetLimit Uses

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

SetLimit sets the Limit field's value.

func (*ListGrantsInput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (ListGrantsInput) String Uses

func (s ListGrantsInput) String() string

String returns the string representation

func (*ListGrantsInput) Validate Uses

func (s *ListGrantsInput) Validate() error

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

type ListGrantsResponse Uses

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 Uses

func (s ListGrantsResponse) GoString() string

GoString returns the string representation

func (*ListGrantsResponse) SetGrants Uses

func (s *ListGrantsResponse) SetGrants(v []*GrantListEntry) *ListGrantsResponse

SetGrants sets the Grants field's value.

func (*ListGrantsResponse) SetNextMarker Uses

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

SetNextMarker sets the NextMarker field's value.

func (*ListGrantsResponse) SetTruncated Uses

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

SetTruncated sets the Truncated field's value.

func (ListGrantsResponse) String Uses

func (s ListGrantsResponse) String() string

String returns the string representation

type ListKeyPoliciesInput Uses

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 Uses

func (s ListKeyPoliciesInput) GoString() string

GoString returns the string representation

func (*ListKeyPoliciesInput) SetKeyId Uses

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

SetKeyId sets the KeyId field's value.

func (*ListKeyPoliciesInput) SetLimit Uses

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

SetLimit sets the Limit field's value.

func (*ListKeyPoliciesInput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (ListKeyPoliciesInput) String Uses

func (s ListKeyPoliciesInput) String() string

String returns the string representation

func (*ListKeyPoliciesInput) Validate Uses

func (s *ListKeyPoliciesInput) Validate() error

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

type ListKeyPoliciesOutput Uses

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 Uses

func (s ListKeyPoliciesOutput) GoString() string

GoString returns the string representation

func (*ListKeyPoliciesOutput) SetNextMarker Uses

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

SetNextMarker sets the NextMarker field's value.

func (*ListKeyPoliciesOutput) SetPolicyNames Uses

func (s *ListKeyPoliciesOutput) SetPolicyNames(v []*string) *ListKeyPoliciesOutput

SetPolicyNames sets the PolicyNames field's value.

func (*ListKeyPoliciesOutput) SetTruncated Uses

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

SetTruncated sets the Truncated field's value.

func (ListKeyPoliciesOutput) String Uses

func (s ListKeyPoliciesOutput) String() string

String returns the string representation

type ListKeysInput Uses

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 Uses

func (s ListKeysInput) GoString() string

GoString returns the string representation

func (*ListKeysInput) SetLimit Uses

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

SetLimit sets the Limit field's value.

func (*ListKeysInput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (ListKeysInput) String Uses

func (s ListKeysInput) String() string

String returns the string representation

func (*ListKeysInput) Validate Uses

func (s *ListKeysInput) Validate() error

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

type ListKeysOutput Uses

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 Uses

func (s ListKeysOutput) GoString() string

GoString returns the string representation

func (*ListKeysOutput) SetKeys Uses

func (s *ListKeysOutput) SetKeys(v []*KeyListEntry) *ListKeysOutput

SetKeys sets the Keys field's value.

func (*ListKeysOutput) SetNextMarker Uses

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

SetNextMarker sets the NextMarker field's value.

func (*ListKeysOutput) SetTruncated Uses

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

SetTruncated sets the Truncated field's value.

func (ListKeysOutput) String Uses

func (s ListKeysOutput) String() string

String returns the string representation

type ListResourceTagsInput Uses

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 Uses

func (s ListResourceTagsInput) GoString() string

GoString returns the string representation

func (*ListResourceTagsInput) SetKeyId Uses

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

SetKeyId sets the KeyId field's value.

func (*ListResourceTagsInput) SetLimit Uses

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

SetLimit sets the Limit field's value.

func (*ListResourceTagsInput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (ListResourceTagsInput) String Uses

func (s ListResourceTagsInput) String() string

String returns the string representation

func (*ListResourceTagsInput) Validate Uses

func (s *ListResourceTagsInput) Validate() error

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

type ListResourceTagsOutput Uses

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 Uses

func (s ListResourceTagsOutput) GoString() string

GoString returns the string representation

func (*ListResourceTagsOutput) SetNextMarker Uses

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

SetNextMarker sets the NextMarker field's value.

func (*ListResourceTagsOutput) SetTags Uses

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

SetTags sets the Tags field's value.

func (*ListResourceTagsOutput) SetTruncated Uses

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

SetTruncated sets the Truncated field's value.

func (ListResourceTagsOutput) String Uses

func (s ListResourceTagsOutput) String() string

String returns the string representation

type ListRetirableGrantsInput Uses

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 Uses

func (s ListRetirableGrantsInput) GoString() string

GoString returns the string representation

func (*ListRetirableGrantsInput) SetLimit Uses

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

SetLimit sets the Limit field's value.

func (*ListRetirableGrantsInput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (*ListRetirableGrantsInput) SetRetiringPrincipal Uses

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

SetRetiringPrincipal sets the RetiringPrincipal field's value.

func (ListRetirableGrantsInput) String Uses

func (s ListRetirableGrantsInput) String() string

String returns the string representation

func (*ListRetirableGrantsInput) Validate Uses

func (s *ListRetirableGrantsInput) Validate() error

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

type PutKeyPolicyInput Uses

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 size limit is 32 kilobytes (32768 bytes).
    //
    // 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 Uses

func (s PutKeyPolicyInput) GoString() string

GoString returns the string representation

func (*PutKeyPolicyInput) SetBypassPolicyLockoutSafetyCheck Uses

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

SetBypassPolicyLockoutSafetyCheck sets the BypassPolicyLockoutSafetyCheck field's value.

func (*PutKeyPolicyInput) SetKeyId Uses

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

SetKeyId sets the KeyId field's value.

func (*PutKeyPolicyInput) SetPolicy Uses

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

SetPolicy sets the Policy field's value.

func (*PutKeyPolicyInput) SetPolicyName Uses

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

SetPolicyName sets the PolicyName field's value.

func (PutKeyPolicyInput) String Uses

func (s PutKeyPolicyInput) String() string

String returns the string representation

func (*PutKeyPolicyInput) Validate Uses

func (s *PutKeyPolicyInput) Validate() error

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

type PutKeyPolicyOutput Uses

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

func (PutKeyPolicyOutput) GoString Uses

func (s PutKeyPolicyOutput) GoString() string

GoString returns the string representation

func (PutKeyPolicyOutput) String Uses

func (s PutKeyPolicyOutput) String() string

String returns the string representation

type ReEncryptInput Uses

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"`

    // Encryption context to use when the data is reencrypted.
    DestinationEncryptionContext map[string]*string `type:"map"`

    // A unique identifier for the CMK that is used to reencrypt the data.
    //
    // 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"`

    // Encryption context used to encrypt and decrypt the data specified in the
    // CiphertextBlob parameter.
    SourceEncryptionContext map[string]*string `type:"map"`
    // contains filtered or unexported fields
}

func (ReEncryptInput) GoString Uses

func (s ReEncryptInput) GoString() string

GoString returns the string representation

func (*ReEncryptInput) SetCiphertextBlob Uses

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

SetCiphertextBlob sets the CiphertextBlob field's value.

func (*ReEncryptInput) SetDestinationEncryptionContext Uses

func (s *ReEncryptInput) SetDestinationEncryptionContext(v map[string]*string) *ReEncryptInput

SetDestinationEncryptionContext sets the DestinationEncryptionContext field's value.

func (*ReEncryptInput) SetDestinationKeyId Uses

func (s *ReEncryptInput) SetDestinationKeyId(v string) *ReEncryptInput

SetDestinationKeyId sets the DestinationKeyId field's value.

func (*ReEncryptInput) SetGrantTokens Uses

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

SetGrantTokens sets the GrantTokens field's value.

func (*ReEncryptInput) SetSourceEncryptionContext Uses

func (s *ReEncryptInput) SetSourceEncryptionContext(v map[string]*string) *ReEncryptInput

SetSourceEncryptionContext sets the SourceEncryptionContext field's value.

func (ReEncryptInput) String Uses

func (s ReEncryptInput) String() string

String returns the string representation

func (*ReEncryptInput) Validate Uses

func (s *ReEncryptInput) Validate() error

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

type ReEncryptOutput Uses

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 encoded.
    //
    // CiphertextBlob is automatically base64 encoded/decoded by the SDK.
    CiphertextBlob []byte `min:"1" type:"blob"`

    // Unique identifier of the CMK used to reencrypt the data.
    KeyId *string `min:"1" type:"string"`

    // 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 Uses

func (s ReEncryptOutput) GoString() string

GoString returns the string representation

func (*ReEncryptOutput) SetCiphertextBlob Uses

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

SetCiphertextBlob sets the CiphertextBlob field's value.

func (*ReEncryptOutput) SetKeyId Uses

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

SetKeyId sets the KeyId field's value.

func (*ReEncryptOutput) SetSourceKeyId Uses

func (s *ReEncryptOutput) SetSourceKeyId(v string) *ReEncryptOutput

SetSourceKeyId sets the SourceKeyId field's value.

func (ReEncryptOutput) String Uses

func (s ReEncryptOutput) String() string

String returns the string representation

type RetireGrantInput Uses

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 Uses

func (s RetireGrantInput) GoString() string

GoString returns the string representation

func (*RetireGrantInput) SetGrantId Uses

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

SetGrantId sets the GrantId field's value.

func (*RetireGrantInput) SetGrantToken Uses

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

SetGrantToken sets the GrantToken field's value.

func (*RetireGrantInput) SetKeyId Uses

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

SetKeyId sets the KeyId field's value.

func (RetireGrantInput) String Uses

func (s RetireGrantInput) String() string

String returns the string representation

func (*RetireGrantInput) Validate Uses

func (s *RetireGrantInput) Validate() error

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

type RetireGrantOutput Uses

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

func (RetireGrantOutput) GoString Uses

func (s RetireGrantOutput) GoString() string

GoString returns the string representation

func (RetireGrantOutput) String Uses

func (s RetireGrantOutput) String() string

String returns the string representation

type RevokeGrantInput Uses

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 Uses

func (s RevokeGrantInput) GoString() string

GoString returns the string representation

func (*RevokeGrantInput) SetGrantId Uses

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

SetGrantId sets the GrantId field's value.

func (*RevokeGrantInput) SetKeyId Uses

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

SetKeyId sets the KeyId field's value.

func (RevokeGrantInput) String Uses

func (s RevokeGrantInput) String() string

String returns the string representation

func (*RevokeGrantInput) Validate Uses

func (s *RevokeGrantInput) Validate() error

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

type RevokeGrantOutput Uses

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

func (RevokeGrantOutput) GoString Uses

func (s RevokeGrantOutput) GoString() string

GoString returns the string representation

func (RevokeGrantOutput) String Uses

func (s RevokeGrantOutput) String() string

String returns the string representation

type ScheduleKeyDeletionInput Uses

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 Uses

func (s ScheduleKeyDeletionInput) GoString() string

GoString returns the string representation

func (*ScheduleKeyDeletionInput) SetKeyId Uses

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

SetKeyId sets the KeyId field's value.

func (*ScheduleKeyDeletionInput) SetPendingWindowInDays Uses

func (s *ScheduleKeyDeletionInput) SetPendingWindowInDays(v int64) *ScheduleKeyDeletionInput

SetPendingWindowInDays sets the PendingWindowInDays field's value.

func (ScheduleKeyDeletionInput) String Uses

func (s ScheduleKeyDeletionInput) String() string

String returns the string representation

func (*ScheduleKeyDeletionInput) Validate Uses

func (s *ScheduleKeyDeletionInput) Validate() error

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

type ScheduleKeyDeletionOutput Uses

type ScheduleKeyDeletionOutput struct {

    // The date and time after which AWS KMS deletes the customer master key (CMK).
    DeletionDate *time.Time `type:"timestamp"`

    // The unique identifier of the customer master key (CMK) for which deletion
    // is scheduled.
    KeyId *string `min:"1" type:"string"`
    // contains filtered or unexported fields
}

func (ScheduleKeyDeletionOutput) GoString Uses

func (s ScheduleKeyDeletionOutput) GoString() string

GoString returns the string representation

func (*ScheduleKeyDeletionOutput) SetDeletionDate Uses

func (s *ScheduleKeyDeletionOutput) SetDeletionDate(v time.Time) *ScheduleKeyDeletionOutput

SetDeletionDate sets the DeletionDate field's value.

func (*ScheduleKeyDeletionOutput) SetKeyId Uses

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

SetKeyId sets the KeyId field's value.

func (ScheduleKeyDeletionOutput) String Uses

func (s ScheduleKeyDeletionOutput) String() string

String returns the string representation

type Tag Uses

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 Uses

func (s Tag) GoString() string

GoString returns the string representation

func (*Tag) SetTagKey Uses

func (s *Tag) SetTagKey(v string) *Tag

SetTagKey sets the TagKey field's value.

func (*Tag) SetTagValue Uses

func (s *Tag) SetTagValue(v string) *Tag

SetTagValue sets the TagValue field's value.

func (Tag) String Uses

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate Uses

func (s *Tag) Validate() error

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

type TagResourceInput Uses

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 Uses

func (s TagResourceInput) GoString() string

GoString returns the string representation

func (*TagResourceInput) SetKeyId Uses

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

SetKeyId sets the KeyId field's value.

func (*TagResourceInput) SetTags