v20190118

package
v3.0.959+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 16, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source 
const (

	// CAM signature/authentication error
	AUTHFAILURE = "AuthFailure"

	// Operation failed.
	FAILEDOPERATION = "FailedOperation"

	// The CMK is being used by a Tencent Cloud product.
	FAILEDOPERATION_CMKUSEDBYCLOUDPRODUCT = "FailedOperation.CmkUsedByCloudProduct"

	// Decryption failed.
	FAILEDOPERATION_DECRYPTERROR = "FailedOperation.DecryptError"

	// Encryption failed.
	FAILEDOPERATION_ENCRYPTIONERROR = "FailedOperation.EncryptionError"

	// Tagging error.
	FAILEDOPERATION_TAGGINGERROR = "FailedOperation.TaggingError"

	// Internal error.
	INTERNALERROR = "InternalError"

	// Invalid parameter.
	INVALIDPARAMETER = "InvalidParameter"

	// Decryption of `EncryptedKeyMaterial` failed.
	INVALIDPARAMETER_DECRYPTMATERIALERROR = "InvalidParameter.DecryptMaterialError"

	// The schedule deletion time parameter is invalid.
	INVALIDPARAMETER_INVALIDPENDINGWINDOWINDAYS = "InvalidParameter.InvalidPendingWindowInDays"

	// Incorrect parameter value.
	INVALIDPARAMETERVALUE = "InvalidParameterValue"

	// The alias already exists.
	INVALIDPARAMETERVALUE_ALIASALREADYEXISTS = "InvalidParameterValue.AliasAlreadyExists"

	// Duplicate `KeyId`.
	INVALIDPARAMETERVALUE_DUPLICATEDKEYID = "InvalidParameterValue.DuplicatedKeyId"

	// Incorrect alias format
	INVALIDPARAMETERVALUE_INVALIDALIAS = "InvalidParameterValue.InvalidAlias"

	// Incorrect ciphertext format
	INVALIDPARAMETERVALUE_INVALIDCIPHERTEXT = "InvalidParameterValue.InvalidCiphertext"

	// Invalid HSM cluster ID.
	INVALIDPARAMETERVALUE_INVALIDHSMCLUSTERID = "InvalidParameterValue.InvalidHsmClusterId"

	// Invalid `KeyId`.
	INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"

	// Incorrect `KeyUsage` parameter.
	INVALIDPARAMETERVALUE_INVALIDKEYUSAGE = "InvalidParameterValue.InvalidKeyUsage"

	// Invalid `Plaintext`.
	INVALIDPARAMETERVALUE_INVALIDPLAINTEXT = "InvalidParameterValue.InvalidPlaintext"

	// Incorrect `Type` parameter.
	INVALIDPARAMETERVALUE_INVALIDTYPE = "InvalidParameterValue.InvalidType"

	// The key material is different from the one previously imported.
	INVALIDPARAMETERVALUE_MATERIALNOTMATCH = "InvalidParameterValue.MaterialNotMatch"

	// Duplicate tag key.
	INVALIDPARAMETERVALUE_TAGKEYSDUPLICATED = "InvalidParameterValue.TagKeysDuplicated"

	// The tag key or tag value does not exist.
	INVALIDPARAMETERVALUE_TAGSNOTEXISTED = "InvalidParameterValue.TagsNotExisted"

	// The number of CMKs has reached the upper limit.
	LIMITEXCEEDED_CMKLIMITEXCEEDED = "LimitExceeded.CmkLimitExceeded"

	// The number of device fingerprints exceeded the limit.
	LIMITEXCEEDED_FINGERPRINTSLIMITEXCEEDED = "LimitExceeded.FingerprintsLimitExceeded"

	// The number of created keys exceeded the limit.
	LIMITEXCEEDED_KEYLIMITEXCEEDED = "LimitExceeded.KeyLimitExceeded"

	// Missing parameters. Please check and try again.
	MISSINGPARAMETER = "MissingParameter"

	// The resource does not exist.
	RESOURCENOTFOUND = "ResourceNotFound"

	// The CMK is not bound with the Tencent Cloud resource
	RESOURCEUNAVAILABLE_CLOUDRESOURCEBINDINGNOTFOUND = "ResourceUnavailable.CloudResourceBindingNotFound"

	// The CMK has been archived.
	RESOURCEUNAVAILABLE_CMKARCHIVED = "ResourceUnavailable.CmkArchived"

	// The CMK has been disabled.
	RESOURCEUNAVAILABLE_CMKDISABLED = "ResourceUnavailable.CmkDisabled"

	// The CMK does not exist.
	RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"

	// As the CMK is not scheduled for deletion, you cannot cancel the schedule deletion.
	RESOURCEUNAVAILABLE_CMKNOTPENDINGDELETE = "ResourceUnavailable.CmkNotPendingDelete"

	// An enabled CMK cannot be scheduled for deletion.
	RESOURCEUNAVAILABLE_CMKSHOULDBEDISABLED = "ResourceUnavailable.CmkShouldBeDisabled"

	// This operation cannot be performed under the current CMK status.
	RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"

	// The key has been disabled.
	RESOURCEUNAVAILABLE_KEYDISABLED = "ResourceUnavailable.KeyDisabled"

	// The key is not available as it’s pending deleted.
	RESOURCEUNAVAILABLE_KEYPENDINGDELETE = "ResourceUnavailable.KeyPendingDelete"

	// The white-box key service has not been activated.
	RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"

	// Token has expired.
	RESOURCEUNAVAILABLE_TOKENEXPIRED = "ResourceUnavailable.TokenExpired"

	// Unauthorized operation.
	UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

	// Unsupported operation.
	UNSUPPORTEDOPERATION = "UnsupportedOperation"

	// External CMKs cannot be rotated.
	UNSUPPORTEDOPERATION_EXTERNALCMKCANNOTROTATE = "UnsupportedOperation.ExternalCmkCanNotRotate"

	// Incorrect CMK type. Only `External` CMKs are supported.
	UNSUPPORTEDOPERATION_NOTEXTERNALCMK = "UnsupportedOperation.NotExternalCmk"

	// You can only update the CMKs created by you.
	UNSUPPORTEDOPERATION_NOTUSERCREATEDCMK = "UnsupportedOperation.NotUserCreatedCmk"

	// The service is temporarily unavailable.
	UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"

	// The encryption method is not supported in the current region.
	UNSUPPORTEDOPERATION_UNSUPPORTEDKEYUSAGEINCURRENTREGION = "UnsupportedOperation.UnsupportedKeyUsageInCurrentRegion"
)
View Source 
const APIVersion = "2019-01-18"

Variables

This section is empty.

Functions

This section is empty.

Types

type AlgorithmInfo 

type AlgorithmInfo struct {
	// Algorithm ID
	KeyUsage *string `json:"KeyUsage,omitnil,omitempty" name:"KeyUsage"`

	// Algorithm name
	Algorithm *string `json:"Algorithm,omitnil,omitempty" name:"Algorithm"`
}

type ArchiveKeyRequest 

type ArchiveKeyRequest struct {
	*tchttp.BaseRequest

	// Unique CMK ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

func NewArchiveKeyRequest 

func NewArchiveKeyRequest() (request *ArchiveKeyRequest)

func (*ArchiveKeyRequest) FromJsonString 

func (r *ArchiveKeyRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ArchiveKeyRequest) ToJsonString 

func (r *ArchiveKeyRequest) ToJsonString() string

type ArchiveKeyRequestParams 

type ArchiveKeyRequestParams struct {
	// Unique CMK ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

Predefined struct for user

type ArchiveKeyResponse 

type ArchiveKeyResponse struct {
	*tchttp.BaseResponse
	Response *ArchiveKeyResponseParams `json:"Response"`
}

func NewArchiveKeyResponse 

func NewArchiveKeyResponse() (response *ArchiveKeyResponse)

func (*ArchiveKeyResponse) FromJsonString 

func (r *ArchiveKeyResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ArchiveKeyResponse) ToJsonString 

func (r *ArchiveKeyResponse) ToJsonString() string

type ArchiveKeyResponseParams 

type ArchiveKeyResponseParams struct {
	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type AsymmetricRsaDecryptRequest 

type AsymmetricRsaDecryptRequest struct {
	*tchttp.BaseRequest

	// Unique CMK ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// Base64-encoded ciphertext encrypted with `PublicKey`
	Ciphertext *string `json:"Ciphertext,omitnil,omitempty" name:"Ciphertext"`

	// Corresponding algorithm when a public key is used for encryption. Valid values: RSAES_PKCS1_V1_5, RSAES_OAEP_SHA_1, RSAES_OAEP_SHA_256
	Algorithm *string `json:"Algorithm,omitnil,omitempty" name:"Algorithm"`
}

func NewAsymmetricRsaDecryptRequest 

func NewAsymmetricRsaDecryptRequest() (request *AsymmetricRsaDecryptRequest)

func (*AsymmetricRsaDecryptRequest) FromJsonString 

func (r *AsymmetricRsaDecryptRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*AsymmetricRsaDecryptRequest) ToJsonString 

func (r *AsymmetricRsaDecryptRequest) ToJsonString() string

type AsymmetricRsaDecryptRequestParams 

type AsymmetricRsaDecryptRequestParams struct {
	// Unique CMK ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// Base64-encoded ciphertext encrypted with `PublicKey`
	Ciphertext *string `json:"Ciphertext,omitnil,omitempty" name:"Ciphertext"`

	// Corresponding algorithm when a public key is used for encryption. Valid values: RSAES_PKCS1_V1_5, RSAES_OAEP_SHA_1, RSAES_OAEP_SHA_256
	Algorithm *string `json:"Algorithm,omitnil,omitempty" name:"Algorithm"`
}

Predefined struct for user

type AsymmetricRsaDecryptResponse 

type AsymmetricRsaDecryptResponse struct {
	*tchttp.BaseResponse
	Response *AsymmetricRsaDecryptResponseParams `json:"Response"`
}

func NewAsymmetricRsaDecryptResponse 

func NewAsymmetricRsaDecryptResponse() (response *AsymmetricRsaDecryptResponse)

func (*AsymmetricRsaDecryptResponse) FromJsonString 

func (r *AsymmetricRsaDecryptResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*AsymmetricRsaDecryptResponse) ToJsonString 

func (r *AsymmetricRsaDecryptResponse) ToJsonString() string

type AsymmetricRsaDecryptResponseParams 

type AsymmetricRsaDecryptResponseParams struct {
	// Unique CMK ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// Base64-encoded plaintext after decryption
	Plaintext *string `json:"Plaintext,omitnil,omitempty" name:"Plaintext"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type AsymmetricSm2DecryptRequest 

type AsymmetricSm2DecryptRequest struct {
	*tchttp.BaseRequest

	// Unique CMK ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// Base64-encoded ciphertext encrypted with `PublicKey`, whose length cannot exceed 256 bytes.
	Ciphertext *string `json:"Ciphertext,omitnil,omitempty" name:"Ciphertext"`
}

func NewAsymmetricSm2DecryptRequest 

func NewAsymmetricSm2DecryptRequest() (request *AsymmetricSm2DecryptRequest)

func (*AsymmetricSm2DecryptRequest) FromJsonString 

func (r *AsymmetricSm2DecryptRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*AsymmetricSm2DecryptRequest) ToJsonString 

func (r *AsymmetricSm2DecryptRequest) ToJsonString() string

type AsymmetricSm2DecryptRequestParams 

type AsymmetricSm2DecryptRequestParams struct {
	// Unique CMK ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// Base64-encoded ciphertext encrypted with `PublicKey`, whose length cannot exceed 256 bytes.
	Ciphertext *string `json:"Ciphertext,omitnil,omitempty" name:"Ciphertext"`
}

Predefined struct for user

type AsymmetricSm2DecryptResponse 

type AsymmetricSm2DecryptResponse struct {
	*tchttp.BaseResponse
	Response *AsymmetricSm2DecryptResponseParams `json:"Response"`
}

func NewAsymmetricSm2DecryptResponse 

func NewAsymmetricSm2DecryptResponse() (response *AsymmetricSm2DecryptResponse)

func (*AsymmetricSm2DecryptResponse) FromJsonString 

func (r *AsymmetricSm2DecryptResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*AsymmetricSm2DecryptResponse) ToJsonString 

func (r *AsymmetricSm2DecryptResponse) ToJsonString() string

type AsymmetricSm2DecryptResponseParams 

type AsymmetricSm2DecryptResponseParams struct {
	// Unique CMK ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// Base64-encoded plaintext after decryption
	Plaintext *string `json:"Plaintext,omitnil,omitempty" name:"Plaintext"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type BindCloudResourceRequest 

type BindCloudResourceRequest struct {
	*tchttp.BaseRequest

	// CMK ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// Unique ID of a Tencent Cloud service
	ProductId *string `json:"ProductId,omitnil,omitempty" name:"ProductId"`

	// Resource/instance ID, which is stored as a string and defined by the caller based on the Tencent Cloud service’s features.
	ResourceId *string `json:"ResourceId,omitnil,omitempty" name:"ResourceId"`
}

func NewBindCloudResourceRequest 

func NewBindCloudResourceRequest() (request *BindCloudResourceRequest)

func (*BindCloudResourceRequest) FromJsonString 

func (r *BindCloudResourceRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BindCloudResourceRequest) ToJsonString 

func (r *BindCloudResourceRequest) ToJsonString() string

type BindCloudResourceRequestParams 

type BindCloudResourceRequestParams struct {
	// CMK ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// Unique ID of a Tencent Cloud service
	ProductId *string `json:"ProductId,omitnil,omitempty" name:"ProductId"`

	// Resource/instance ID, which is stored as a string and defined by the caller based on the Tencent Cloud service’s features.
	ResourceId *string `json:"ResourceId,omitnil,omitempty" name:"ResourceId"`
}

Predefined struct for user

type BindCloudResourceResponse 

type BindCloudResourceResponse struct {
	*tchttp.BaseResponse
	Response *BindCloudResourceResponseParams `json:"Response"`
}

func NewBindCloudResourceResponse 

func NewBindCloudResourceResponse() (response *BindCloudResourceResponse)

func (*BindCloudResourceResponse) FromJsonString 

func (r *BindCloudResourceResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*BindCloudResourceResponse) ToJsonString 

func (r *BindCloudResourceResponse) ToJsonString() string

type BindCloudResourceResponseParams 

type BindCloudResourceResponseParams struct {
	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type CancelKeyArchiveRequest 

type CancelKeyArchiveRequest struct {
	*tchttp.BaseRequest

	// Unique CMK ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

func NewCancelKeyArchiveRequest 

func NewCancelKeyArchiveRequest() (request *CancelKeyArchiveRequest)

func (*CancelKeyArchiveRequest) FromJsonString 

func (r *CancelKeyArchiveRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CancelKeyArchiveRequest) ToJsonString 

func (r *CancelKeyArchiveRequest) ToJsonString() string

type CancelKeyArchiveRequestParams 

type CancelKeyArchiveRequestParams struct {
	// Unique CMK ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

Predefined struct for user

type CancelKeyArchiveResponse 

type CancelKeyArchiveResponse struct {
	*tchttp.BaseResponse
	Response *CancelKeyArchiveResponseParams `json:"Response"`
}

func NewCancelKeyArchiveResponse 

func NewCancelKeyArchiveResponse() (response *CancelKeyArchiveResponse)

func (*CancelKeyArchiveResponse) FromJsonString 

func (r *CancelKeyArchiveResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CancelKeyArchiveResponse) ToJsonString 

func (r *CancelKeyArchiveResponse) ToJsonString() string

type CancelKeyArchiveResponseParams 

type CancelKeyArchiveResponseParams struct {
	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type CancelKeyDeletionRequest 

type CancelKeyDeletionRequest struct {
	*tchttp.BaseRequest

	// Unique ID of the CMK for which to cancel schedule deletion
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

func NewCancelKeyDeletionRequest 

func NewCancelKeyDeletionRequest() (request *CancelKeyDeletionRequest)

func (*CancelKeyDeletionRequest) FromJsonString 

func (r *CancelKeyDeletionRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CancelKeyDeletionRequest) ToJsonString 

func (r *CancelKeyDeletionRequest) ToJsonString() string

type CancelKeyDeletionRequestParams 

type CancelKeyDeletionRequestParams struct {
	// Unique ID of the CMK for which to cancel schedule deletion
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

Predefined struct for user

type CancelKeyDeletionResponse 

type CancelKeyDeletionResponse struct {
	*tchttp.BaseResponse
	Response *CancelKeyDeletionResponseParams `json:"Response"`
}

func NewCancelKeyDeletionResponse 

func NewCancelKeyDeletionResponse() (response *CancelKeyDeletionResponse)

func (*CancelKeyDeletionResponse) FromJsonString 

func (r *CancelKeyDeletionResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CancelKeyDeletionResponse) ToJsonString 

func (r *CancelKeyDeletionResponse) ToJsonString() string

type CancelKeyDeletionResponseParams 

type CancelKeyDeletionResponseParams struct {
	// Unique ID of the CMK for which the schedule deletion is canceled
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type Client 

type Client struct {
	common.Client
}

func NewClient 

func NewClient(credential common.CredentialIface, region string, clientProfile *profile.ClientProfile) (client *Client, err error)

func NewClientWithSecretId 

func NewClientWithSecretId(secretId, secretKey, region string) (client *Client, err error)

Deprecated

func (*Client) ArchiveKey 

func (c *Client) ArchiveKey(request *ArchiveKeyRequest) (response *ArchiveKeyResponse, err error)

ArchiveKey This API is used to archive keys. The archived keys can only be used for decryption but not encryption.

error code that may be returned: 

FAILEDOPERATION_CMKUSEDBYCLOUDPRODUCT = "FailedOperation.CmkUsedByCloudProduct"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_NOTUSERCREATEDCMK = "UnsupportedOperation.NotUserCreatedCmk"
UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"

func (*Client) ArchiveKeyWithContext 

func (c *Client) ArchiveKeyWithContext(ctx context.Context, request *ArchiveKeyRequest) (response *ArchiveKeyResponse, err error)

ArchiveKey This API is used to archive keys. The archived keys can only be used for decryption but not encryption.

error code that may be returned: 

FAILEDOPERATION_CMKUSEDBYCLOUDPRODUCT = "FailedOperation.CmkUsedByCloudProduct"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_NOTUSERCREATEDCMK = "UnsupportedOperation.NotUserCreatedCmk"
UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"

func (*Client) AsymmetricRsaDecrypt 

func (c *Client) AsymmetricRsaDecrypt(request *AsymmetricRsaDecryptRequest) (response *AsymmetricRsaDecryptResponse, err error)

AsymmetricRsaDecrypt This API is used to decrypt data with the specified private key that is encrypted with RSA asymmetric cryptographic algorithm. The ciphertext must be encrypted with the corresponding public key. The asymmetric key must be in `Enabled` state for decryption.

error code that may be returned: 

FAILEDOPERATION_DECRYPTERROR = "FailedOperation.DecryptError"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
INVALIDPARAMETERVALUE_INVALIDKEYUSAGE = "InvalidParameterValue.InvalidKeyUsage"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) AsymmetricRsaDecryptWithContext 

func (c *Client) AsymmetricRsaDecryptWithContext(ctx context.Context, request *AsymmetricRsaDecryptRequest) (response *AsymmetricRsaDecryptResponse, err error)

AsymmetricRsaDecrypt This API is used to decrypt data with the specified private key that is encrypted with RSA asymmetric cryptographic algorithm. The ciphertext must be encrypted with the corresponding public key. The asymmetric key must be in `Enabled` state for decryption.

error code that may be returned: 

FAILEDOPERATION_DECRYPTERROR = "FailedOperation.DecryptError"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
INVALIDPARAMETERVALUE_INVALIDKEYUSAGE = "InvalidParameterValue.InvalidKeyUsage"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) AsymmetricSm2Decrypt 

func (c *Client) AsymmetricSm2Decrypt(request *AsymmetricSm2DecryptRequest) (response *AsymmetricSm2DecryptResponse, err error)

AsymmetricSm2Decrypt This API is used to decrypt data with the specified private key that is encrypted with SM2 asymmetric cryptographic algorithm. The ciphertext must be encrypted with the corresponding public key. The asymmetric key must be in `Enabled` state for decryption. The length of the ciphertext passed in cannot exceed 256 bytes.

error code that may be returned: 

FAILEDOPERATION_DECRYPTERROR = "FailedOperation.DecryptError"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
INVALIDPARAMETERVALUE_INVALIDKEYUSAGE = "InvalidParameterValue.InvalidKeyUsage"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_UNSUPPORTEDKEYUSAGEINCURRENTREGION = "UnsupportedOperation.UnsupportedKeyUsageInCurrentRegion"

func (*Client) AsymmetricSm2DecryptWithContext 

func (c *Client) AsymmetricSm2DecryptWithContext(ctx context.Context, request *AsymmetricSm2DecryptRequest) (response *AsymmetricSm2DecryptResponse, err error)

AsymmetricSm2Decrypt This API is used to decrypt data with the specified private key that is encrypted with SM2 asymmetric cryptographic algorithm. The ciphertext must be encrypted with the corresponding public key. The asymmetric key must be in `Enabled` state for decryption. The length of the ciphertext passed in cannot exceed 256 bytes.

error code that may be returned: 

FAILEDOPERATION_DECRYPTERROR = "FailedOperation.DecryptError"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
INVALIDPARAMETERVALUE_INVALIDKEYUSAGE = "InvalidParameterValue.InvalidKeyUsage"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_UNSUPPORTEDKEYUSAGEINCURRENTREGION = "UnsupportedOperation.UnsupportedKeyUsageInCurrentRegion"

func (*Client) BindCloudResource 

func (c *Client) BindCloudResource(request *BindCloudResourceRequest) (response *BindCloudResourceResponse, err error)

BindCloudResource This API is used to bind a key with a Tencent Cloud resource. If the key has been set to be expired automatically, the setting will be canceled to ensure that the key will not be invalid automatically. If the key and the resource has already been bound, the call will still be successful.

error code that may be returned: 

FAILEDOPERATION_CMKUSEDBYCLOUDPRODUCT = "FailedOperation.CmkUsedByCloudProduct"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"
UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"

func (*Client) BindCloudResourceWithContext 

func (c *Client) BindCloudResourceWithContext(ctx context.Context, request *BindCloudResourceRequest) (response *BindCloudResourceResponse, err error)

BindCloudResource This API is used to bind a key with a Tencent Cloud resource. If the key has been set to be expired automatically, the setting will be canceled to ensure that the key will not be invalid automatically. If the key and the resource has already been bound, the call will still be successful.

error code that may be returned: 

FAILEDOPERATION_CMKUSEDBYCLOUDPRODUCT = "FailedOperation.CmkUsedByCloudProduct"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"
UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"

func (*Client) CancelKeyArchive 

func (c *Client) CancelKeyArchive(request *CancelKeyArchiveRequest) (response *CancelKeyArchiveResponse, err error)

CancelKeyArchive This API is used to unarchive keys. If a key is unarchived, its status will be `Enabled`.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_NOTUSERCREATEDCMK = "UnsupportedOperation.NotUserCreatedCmk"
UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"

func (*Client) CancelKeyArchiveWithContext 

func (c *Client) CancelKeyArchiveWithContext(ctx context.Context, request *CancelKeyArchiveRequest) (response *CancelKeyArchiveResponse, err error)

CancelKeyArchive This API is used to unarchive keys. If a key is unarchived, its status will be `Enabled`.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_NOTUSERCREATEDCMK = "UnsupportedOperation.NotUserCreatedCmk"
UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"

func (*Client) CancelKeyDeletion 

func (c *Client) CancelKeyDeletion(request *CancelKeyDeletionRequest) (response *CancelKeyDeletionResponse, err error)

CancelKeyDeletion Cancel the scheduled deletion of CMK

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKNOTPENDINGDELETE = "ResourceUnavailable.CmkNotPendingDelete"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"

func (*Client) CancelKeyDeletionWithContext 

func (c *Client) CancelKeyDeletionWithContext(ctx context.Context, request *CancelKeyDeletionRequest) (response *CancelKeyDeletionResponse, err error)

CancelKeyDeletion Cancel the scheduled deletion of CMK

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKNOTPENDINGDELETE = "ResourceUnavailable.CmkNotPendingDelete"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"

func (*Client) CreateKey 

func (c *Client) CreateKey(request *CreateKeyRequest) (response *CreateKeyResponse, err error)

CreateKey Create a master key CMK (Custom Master Key) for user management data keys

error code that may be returned: 

FAILEDOPERATION_TAGGINGERROR = "FailedOperation.TaggingError"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_ALIASALREADYEXISTS = "InvalidParameterValue.AliasAlreadyExists"
INVALIDPARAMETERVALUE_INVALIDALIAS = "InvalidParameterValue.InvalidAlias"
INVALIDPARAMETERVALUE_INVALIDHSMCLUSTERID = "InvalidParameterValue.InvalidHsmClusterId"
INVALIDPARAMETERVALUE_INVALIDKEYUSAGE = "InvalidParameterValue.InvalidKeyUsage"
INVALIDPARAMETERVALUE_INVALIDTYPE = "InvalidParameterValue.InvalidType"
INVALIDPARAMETERVALUE_TAGKEYSDUPLICATED = "InvalidParameterValue.TagKeysDuplicated"
INVALIDPARAMETERVALUE_TAGSNOTEXISTED = "InvalidParameterValue.TagsNotExisted"
LIMITEXCEEDED_CMKLIMITEXCEEDED = "LimitExceeded.CmkLimitExceeded"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"
UNSUPPORTEDOPERATION_UNSUPPORTEDKEYUSAGEINCURRENTREGION = "UnsupportedOperation.UnsupportedKeyUsageInCurrentRegion"

func (*Client) CreateKeyWithContext 

func (c *Client) CreateKeyWithContext(ctx context.Context, request *CreateKeyRequest) (response *CreateKeyResponse, err error)

CreateKey Create a master key CMK (Custom Master Key) for user management data keys

error code that may be returned: 

FAILEDOPERATION_TAGGINGERROR = "FailedOperation.TaggingError"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_ALIASALREADYEXISTS = "InvalidParameterValue.AliasAlreadyExists"
INVALIDPARAMETERVALUE_INVALIDALIAS = "InvalidParameterValue.InvalidAlias"
INVALIDPARAMETERVALUE_INVALIDHSMCLUSTERID = "InvalidParameterValue.InvalidHsmClusterId"
INVALIDPARAMETERVALUE_INVALIDKEYUSAGE = "InvalidParameterValue.InvalidKeyUsage"
INVALIDPARAMETERVALUE_INVALIDTYPE = "InvalidParameterValue.InvalidType"
INVALIDPARAMETERVALUE_TAGKEYSDUPLICATED = "InvalidParameterValue.TagKeysDuplicated"
INVALIDPARAMETERVALUE_TAGSNOTEXISTED = "InvalidParameterValue.TagsNotExisted"
LIMITEXCEEDED_CMKLIMITEXCEEDED = "LimitExceeded.CmkLimitExceeded"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"
UNSUPPORTEDOPERATION_UNSUPPORTEDKEYUSAGEINCURRENTREGION = "UnsupportedOperation.UnsupportedKeyUsageInCurrentRegion"

func (*Client) CreateWhiteBoxKey 

func (c *Client) CreateWhiteBoxKey(request *CreateWhiteBoxKeyRequest) (response *CreateWhiteBoxKeyResponse, err error)

CreateWhiteBoxKey This API is used to create a white-box key. Up to 50 ones can be created.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_ALIASALREADYEXISTS = "InvalidParameterValue.AliasAlreadyExists"
INVALIDPARAMETERVALUE_INVALIDALIAS = "InvalidParameterValue.InvalidAlias"
INVALIDPARAMETERVALUE_TAGKEYSDUPLICATED = "InvalidParameterValue.TagKeysDuplicated"
INVALIDPARAMETERVALUE_TAGSNOTEXISTED = "InvalidParameterValue.TagsNotExisted"
LIMITEXCEEDED_KEYLIMITEXCEEDED = "LimitExceeded.KeyLimitExceeded"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) CreateWhiteBoxKeyWithContext 

func (c *Client) CreateWhiteBoxKeyWithContext(ctx context.Context, request *CreateWhiteBoxKeyRequest) (response *CreateWhiteBoxKeyResponse, err error)

CreateWhiteBoxKey This API is used to create a white-box key. Up to 50 ones can be created.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_ALIASALREADYEXISTS = "InvalidParameterValue.AliasAlreadyExists"
INVALIDPARAMETERVALUE_INVALIDALIAS = "InvalidParameterValue.InvalidAlias"
INVALIDPARAMETERVALUE_TAGKEYSDUPLICATED = "InvalidParameterValue.TagKeysDuplicated"
INVALIDPARAMETERVALUE_TAGSNOTEXISTED = "InvalidParameterValue.TagsNotExisted"
LIMITEXCEEDED_KEYLIMITEXCEEDED = "LimitExceeded.KeyLimitExceeded"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) Decrypt 

func (c *Client) Decrypt(request *DecryptRequest) (response *DecryptResponse, err error)

Decrypt This API is used to decrypt the ciphertext and obtain the plaintext data.

error code that may be returned: 

FAILEDOPERATION_ENCRYPTIONERROR = "FailedOperation.EncryptionError"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDCIPHERTEXT = "InvalidParameterValue.InvalidCiphertext"
RESOURCEUNAVAILABLE_CMKDISABLED = "ResourceUnavailable.CmkDisabled"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DecryptWithContext 

func (c *Client) DecryptWithContext(ctx context.Context, request *DecryptRequest) (response *DecryptResponse, err error)

Decrypt This API is used to decrypt the ciphertext and obtain the plaintext data.

error code that may be returned: 

FAILEDOPERATION_ENCRYPTIONERROR = "FailedOperation.EncryptionError"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDCIPHERTEXT = "InvalidParameterValue.InvalidCiphertext"
RESOURCEUNAVAILABLE_CMKDISABLED = "ResourceUnavailable.CmkDisabled"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DeleteImportedKeyMaterial 

func (c *Client) DeleteImportedKeyMaterial(request *DeleteImportedKeyMaterialRequest) (response *DeleteImportedKeyMaterialResponse, err error)

DeleteImportedKeyMaterial This API is used to delete the imported key material. It is only valid for EXTERNAL CMKs. Specifically, it puts a CMK into `PendingImport` status instead of deleting the CMK, so that the CMK can be used again after key material is reimported. To delete the CMK completely, please call the `ScheduleKeyDeletion` API.

error code that may be returned: 

FAILEDOPERATION_CMKUSEDBYCLOUDPRODUCT = "FailedOperation.CmkUsedByCloudProduct"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"
UNSUPPORTEDOPERATION_NOTEXTERNALCMK = "UnsupportedOperation.NotExternalCmk"
UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"

func (*Client) DeleteImportedKeyMaterialWithContext 

func (c *Client) DeleteImportedKeyMaterialWithContext(ctx context.Context, request *DeleteImportedKeyMaterialRequest) (response *DeleteImportedKeyMaterialResponse, err error)

DeleteImportedKeyMaterial This API is used to delete the imported key material. It is only valid for EXTERNAL CMKs. Specifically, it puts a CMK into `PendingImport` status instead of deleting the CMK, so that the CMK can be used again after key material is reimported. To delete the CMK completely, please call the `ScheduleKeyDeletion` API.

error code that may be returned: 

FAILEDOPERATION_CMKUSEDBYCLOUDPRODUCT = "FailedOperation.CmkUsedByCloudProduct"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"
UNSUPPORTEDOPERATION_NOTEXTERNALCMK = "UnsupportedOperation.NotExternalCmk"
UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"

func (*Client) DeleteWhiteBoxKey 

func (c *Client) DeleteWhiteBoxKey(request *DeleteWhiteBoxKeyRequest) (response *DeleteWhiteBoxKeyResponse, err error)

DeleteWhiteBoxKey This API is used to delete a white-box key. Note: only disabled white-box keys can be deleted.

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DeleteWhiteBoxKeyWithContext 

func (c *Client) DeleteWhiteBoxKeyWithContext(ctx context.Context, request *DeleteWhiteBoxKeyRequest) (response *DeleteWhiteBoxKeyResponse, err error)

DeleteWhiteBoxKey This API is used to delete a white-box key. Note: only disabled white-box keys can be deleted.

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DescribeKey 

func (c *Client) DescribeKey(request *DescribeKeyRequest) (response *DescribeKeyResponse, err error)

DescribeKey This API is used to get the attribute details of the CMK with a specified `KeyId`.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DescribeKeyWithContext 

func (c *Client) DescribeKeyWithContext(ctx context.Context, request *DescribeKeyRequest) (response *DescribeKeyResponse, err error)

DescribeKey This API is used to get the attribute details of the CMK with a specified `KeyId`.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DescribeKeys 

func (c *Client) DescribeKeys(request *DescribeKeysRequest) (response *DescribeKeysResponse, err error)

DescribeKeys This API is used to get the attribute information of CMKs in batches.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_DUPLICATEDKEYID = "InvalidParameterValue.DuplicatedKeyId"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DescribeKeysWithContext 

func (c *Client) DescribeKeysWithContext(ctx context.Context, request *DescribeKeysRequest) (response *DescribeKeysResponse, err error)

DescribeKeys This API is used to get the attribute information of CMKs in batches.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_DUPLICATEDKEYID = "InvalidParameterValue.DuplicatedKeyId"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DescribeWhiteBoxDecryptKey 

func (c *Client) DescribeWhiteBoxDecryptKey(request *DescribeWhiteBoxDecryptKeyRequest) (response *DescribeWhiteBoxDecryptKeyResponse, err error)

DescribeWhiteBoxDecryptKey This API is used to get a white-box decryption key.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DescribeWhiteBoxDecryptKeyWithContext 

func (c *Client) DescribeWhiteBoxDecryptKeyWithContext(ctx context.Context, request *DescribeWhiteBoxDecryptKeyRequest) (response *DescribeWhiteBoxDecryptKeyResponse, err error)

DescribeWhiteBoxDecryptKey This API is used to get a white-box decryption key.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DescribeWhiteBoxDeviceFingerprints 

func (c *Client) DescribeWhiteBoxDeviceFingerprints(request *DescribeWhiteBoxDeviceFingerprintsRequest) (response *DescribeWhiteBoxDeviceFingerprintsResponse, err error)

DescribeWhiteBoxDeviceFingerprints This API is used to get the device fingerprint list of a specified key.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DescribeWhiteBoxDeviceFingerprintsWithContext 

func (c *Client) DescribeWhiteBoxDeviceFingerprintsWithContext(ctx context.Context, request *DescribeWhiteBoxDeviceFingerprintsRequest) (response *DescribeWhiteBoxDeviceFingerprintsResponse, err error)

DescribeWhiteBoxDeviceFingerprints This API is used to get the device fingerprint list of a specified key.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DescribeWhiteBoxKey 

func (c *Client) DescribeWhiteBoxKey(request *DescribeWhiteBoxKeyRequest) (response *DescribeWhiteBoxKeyResponse, err error)

DescribeWhiteBoxKey This API is used to display white-box key information.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DescribeWhiteBoxKeyDetails 

func (c *Client) DescribeWhiteBoxKeyDetails(request *DescribeWhiteBoxKeyDetailsRequest) (response *DescribeWhiteBoxKeyDetailsResponse, err error)

DescribeWhiteBoxKeyDetails This API is used to get the white-box key list.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DescribeWhiteBoxKeyDetailsWithContext 

func (c *Client) DescribeWhiteBoxKeyDetailsWithContext(ctx context.Context, request *DescribeWhiteBoxKeyDetailsRequest) (response *DescribeWhiteBoxKeyDetailsResponse, err error)

DescribeWhiteBoxKeyDetails This API is used to get the white-box key list.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DescribeWhiteBoxKeyWithContext 

func (c *Client) DescribeWhiteBoxKeyWithContext(ctx context.Context, request *DescribeWhiteBoxKeyRequest) (response *DescribeWhiteBoxKeyResponse, err error)

DescribeWhiteBoxKey This API is used to display white-box key information.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DescribeWhiteBoxServiceStatus 

func (c *Client) DescribeWhiteBoxServiceStatus(request *DescribeWhiteBoxServiceStatusRequest) (response *DescribeWhiteBoxServiceStatusResponse, err error)

DescribeWhiteBoxServiceStatus This API is used to get the white-box key service status.

error code that may be returned: 

INTERNALERROR = "InternalError"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DescribeWhiteBoxServiceStatusWithContext 

func (c *Client) DescribeWhiteBoxServiceStatusWithContext(ctx context.Context, request *DescribeWhiteBoxServiceStatusRequest) (response *DescribeWhiteBoxServiceStatusResponse, err error)

DescribeWhiteBoxServiceStatus This API is used to get the white-box key service status.

error code that may be returned: 

INTERNALERROR = "InternalError"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DisableKey 

func (c *Client) DisableKey(request *DisableKeyRequest) (response *DisableKeyResponse, err error)

DisableKey This API is used to disable a master key. The disabled key cannot be used for encryption and decryption operations.

error code that may be returned: 

FAILEDOPERATION_CMKUSEDBYCLOUDPRODUCT = "FailedOperation.CmkUsedByCloudProduct"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"

func (*Client) DisableKeyRotation 

func (c *Client) DisableKeyRotation(request *DisableKeyRotationRequest) (response *DisableKeyRotationResponse, err error)

DisableKeyRotation Disabled key rotation for the specified CMK.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DisableKeyRotationWithContext 

func (c *Client) DisableKeyRotationWithContext(ctx context.Context, request *DisableKeyRotationRequest) (response *DisableKeyRotationResponse, err error)

DisableKeyRotation Disabled key rotation for the specified CMK.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DisableKeyWithContext 

func (c *Client) DisableKeyWithContext(ctx context.Context, request *DisableKeyRequest) (response *DisableKeyResponse, err error)

DisableKey This API is used to disable a master key. The disabled key cannot be used for encryption and decryption operations.

error code that may be returned: 

FAILEDOPERATION_CMKUSEDBYCLOUDPRODUCT = "FailedOperation.CmkUsedByCloudProduct"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"

func (*Client) DisableKeys 

func (c *Client) DisableKeys(request *DisableKeysRequest) (response *DisableKeysResponse, err error)

DisableKeys This API is used to batch prohibit the use of CMK.

error code that may be returned: 

FAILEDOPERATION_CMKUSEDBYCLOUDPRODUCT = "FailedOperation.CmkUsedByCloudProduct"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_DUPLICATEDKEYID = "InvalidParameterValue.DuplicatedKeyId"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"

func (*Client) DisableKeysWithContext 

func (c *Client) DisableKeysWithContext(ctx context.Context, request *DisableKeysRequest) (response *DisableKeysResponse, err error)

DisableKeys This API is used to batch prohibit the use of CMK.

error code that may be returned: 

FAILEDOPERATION_CMKUSEDBYCLOUDPRODUCT = "FailedOperation.CmkUsedByCloudProduct"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_DUPLICATEDKEYID = "InvalidParameterValue.DuplicatedKeyId"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"

func (*Client) DisableWhiteBoxKey 

func (c *Client) DisableWhiteBoxKey(request *DisableWhiteBoxKeyRequest) (response *DisableWhiteBoxKeyResponse, err error)

DisableWhiteBoxKey This API is used to disable a white-box key.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DisableWhiteBoxKeyWithContext 

func (c *Client) DisableWhiteBoxKeyWithContext(ctx context.Context, request *DisableWhiteBoxKeyRequest) (response *DisableWhiteBoxKeyResponse, err error)

DisableWhiteBoxKey This API is used to disable a white-box key.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DisableWhiteBoxKeys 

func (c *Client) DisableWhiteBoxKeys(request *DisableWhiteBoxKeysRequest) (response *DisableWhiteBoxKeysResponse, err error)

DisableWhiteBoxKeys This API is used to disable white-box keys in batches.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_DUPLICATEDKEYID = "InvalidParameterValue.DuplicatedKeyId"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DisableWhiteBoxKeysWithContext 

func (c *Client) DisableWhiteBoxKeysWithContext(ctx context.Context, request *DisableWhiteBoxKeysRequest) (response *DisableWhiteBoxKeysResponse, err error)

DisableWhiteBoxKeys This API is used to disable white-box keys in batches.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_DUPLICATEDKEYID = "InvalidParameterValue.DuplicatedKeyId"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) EnableKey 

func (c *Client) EnableKey(request *EnableKeyRequest) (response *EnableKeyResponse, err error)

EnableKey Enable a specified CMK.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"

func (*Client) EnableKeyRotation 

func (c *Client) EnableKeyRotation(request *EnableKeyRotationRequest) (response *EnableKeyRotationResponse, err error)

EnableKeyRotation Turn on the key rotation function for the specified CMK.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_EXTERNALCMKCANNOTROTATE = "UnsupportedOperation.ExternalCmkCanNotRotate"
UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"

func (*Client) EnableKeyRotationWithContext 

func (c *Client) EnableKeyRotationWithContext(ctx context.Context, request *EnableKeyRotationRequest) (response *EnableKeyRotationResponse, err error)

EnableKeyRotation Turn on the key rotation function for the specified CMK.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_EXTERNALCMKCANNOTROTATE = "UnsupportedOperation.ExternalCmkCanNotRotate"
UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"

func (*Client) EnableKeyWithContext 

func (c *Client) EnableKeyWithContext(ctx context.Context, request *EnableKeyRequest) (response *EnableKeyResponse, err error)

EnableKey Enable a specified CMK.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"

func (*Client) EnableKeys 

func (c *Client) EnableKeys(request *EnableKeysRequest) (response *EnableKeysResponse, err error)

EnableKeys This API is used to enable CMK in batches.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_DUPLICATEDKEYID = "InvalidParameterValue.DuplicatedKeyId"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"

func (*Client) EnableKeysWithContext 

func (c *Client) EnableKeysWithContext(ctx context.Context, request *EnableKeysRequest) (response *EnableKeysResponse, err error)

EnableKeys This API is used to enable CMK in batches.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_DUPLICATEDKEYID = "InvalidParameterValue.DuplicatedKeyId"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"

func (*Client) EnableWhiteBoxKey 

func (c *Client) EnableWhiteBoxKey(request *EnableWhiteBoxKeyRequest) (response *EnableWhiteBoxKeyResponse, err error)

EnableWhiteBoxKey This API is used to enable a white-box key.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) EnableWhiteBoxKeyWithContext 

func (c *Client) EnableWhiteBoxKeyWithContext(ctx context.Context, request *EnableWhiteBoxKeyRequest) (response *EnableWhiteBoxKeyResponse, err error)

EnableWhiteBoxKey This API is used to enable a white-box key.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) EnableWhiteBoxKeys 

func (c *Client) EnableWhiteBoxKeys(request *EnableWhiteBoxKeysRequest) (response *EnableWhiteBoxKeysResponse, err error)

EnableWhiteBoxKeys This API is used to enable white-box keys in batches.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_DUPLICATEDKEYID = "InvalidParameterValue.DuplicatedKeyId"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) EnableWhiteBoxKeysWithContext 

func (c *Client) EnableWhiteBoxKeysWithContext(ctx context.Context, request *EnableWhiteBoxKeysRequest) (response *EnableWhiteBoxKeysResponse, err error)

EnableWhiteBoxKeys This API is used to enable white-box keys in batches.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_DUPLICATEDKEYID = "InvalidParameterValue.DuplicatedKeyId"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) Encrypt 

func (c *Client) Encrypt(request *EncryptRequest) (response *EncryptResponse, err error)

Encrypt This API is used to encrypt any data up to 4KB. It can be used to encrypt database passwords, RSA Key, or other small sensitive information. For application data encryption, use the DataKey generated by GenerateDataKey to perform local data encryption and decryption operations

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
INVALIDPARAMETERVALUE_INVALIDPLAINTEXT = "InvalidParameterValue.InvalidPlaintext"
RESOURCEUNAVAILABLE_CMKARCHIVED = "ResourceUnavailable.CmkArchived"
RESOURCEUNAVAILABLE_CMKDISABLED = "ResourceUnavailable.CmkDisabled"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) EncryptByWhiteBox 

func (c *Client) EncryptByWhiteBox(request *EncryptByWhiteBoxRequest) (response *EncryptByWhiteBoxResponse, err error)

EncryptByWhiteBox This API is used to encrypt data with a white-box key.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_KEYDISABLED = "ResourceUnavailable.KeyDisabled"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) EncryptByWhiteBoxWithContext 

func (c *Client) EncryptByWhiteBoxWithContext(ctx context.Context, request *EncryptByWhiteBoxRequest) (response *EncryptByWhiteBoxResponse, err error)

EncryptByWhiteBox This API is used to encrypt data with a white-box key.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_KEYDISABLED = "ResourceUnavailable.KeyDisabled"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) EncryptWithContext 

func (c *Client) EncryptWithContext(ctx context.Context, request *EncryptRequest) (response *EncryptResponse, err error)

Encrypt This API is used to encrypt any data up to 4KB. It can be used to encrypt database passwords, RSA Key, or other small sensitive information. For application data encryption, use the DataKey generated by GenerateDataKey to perform local data encryption and decryption operations

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
INVALIDPARAMETERVALUE_INVALIDPLAINTEXT = "InvalidParameterValue.InvalidPlaintext"
RESOURCEUNAVAILABLE_CMKARCHIVED = "ResourceUnavailable.CmkArchived"
RESOURCEUNAVAILABLE_CMKDISABLED = "ResourceUnavailable.CmkDisabled"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) GenerateDataKey 

func (c *Client) GenerateDataKey(request *GenerateDataKeyRequest) (response *GenerateDataKeyResponse, err error)

GenerateDataKey This API generates a data key, which you can use to encrypt local data.

error code that may be returned: 

FAILEDOPERATION_ENCRYPTIONERROR = "FailedOperation.EncryptionError"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKDISABLED = "ResourceUnavailable.CmkDisabled"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_KEYPENDINGDELETE = "ResourceUnavailable.KeyPendingDelete"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) GenerateDataKeyWithContext 

func (c *Client) GenerateDataKeyWithContext(ctx context.Context, request *GenerateDataKeyRequest) (response *GenerateDataKeyResponse, err error)

GenerateDataKey This API generates a data key, which you can use to encrypt local data.

error code that may be returned: 

FAILEDOPERATION_ENCRYPTIONERROR = "FailedOperation.EncryptionError"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKDISABLED = "ResourceUnavailable.CmkDisabled"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_KEYPENDINGDELETE = "ResourceUnavailable.KeyPendingDelete"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) GenerateRandom 

func (c *Client) GenerateRandom(request *GenerateRandomRequest) (response *GenerateRandomResponse, err error)

GenerateRandom This API is used to generate a random number.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) GenerateRandomWithContext 

func (c *Client) GenerateRandomWithContext(ctx context.Context, request *GenerateRandomRequest) (response *GenerateRandomResponse, err error)

GenerateRandom This API is used to generate a random number.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) GetKeyRotationStatus 

func (c *Client) GetKeyRotationStatus(request *GetKeyRotationStatusRequest) (response *GetKeyRotationStatusResponse, err error)

GetKeyRotationStatus Query whether the specified CMK has the key rotation function.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) GetKeyRotationStatusWithContext 

func (c *Client) GetKeyRotationStatusWithContext(ctx context.Context, request *GetKeyRotationStatusRequest) (response *GetKeyRotationStatusResponse, err error)

GetKeyRotationStatus Query whether the specified CMK has the key rotation function.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) GetParametersForImport 

func (c *Client) GetParametersForImport(request *GetParametersForImportRequest) (response *GetParametersForImportResponse, err error)

GetParametersForImport This API is used to obtain the parameters of the material to be imported into a CMK. The returned `Token` is used as one of the parameters to execute `ImportKeyMaterial`, and the returned `PublicKey` is used to encrypt the key material. The `Token` and `PublicKey` are valid for 24 hours. If they are expired, you will need to call the API again to get a new `Token` and `PublicKey`.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
UNSUPPORTEDOPERATION_NOTEXTERNALCMK = "UnsupportedOperation.NotExternalCmk"
UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"

func (*Client) GetParametersForImportWithContext 

func (c *Client) GetParametersForImportWithContext(ctx context.Context, request *GetParametersForImportRequest) (response *GetParametersForImportResponse, err error)

GetParametersForImport This API is used to obtain the parameters of the material to be imported into a CMK. The returned `Token` is used as one of the parameters to execute `ImportKeyMaterial`, and the returned `PublicKey` is used to encrypt the key material. The `Token` and `PublicKey` are valid for 24 hours. If they are expired, you will need to call the API again to get a new `Token` and `PublicKey`.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
UNSUPPORTEDOPERATION_NOTEXTERNALCMK = "UnsupportedOperation.NotExternalCmk"
UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"

func (*Client) GetPublicKey 

func (c *Client) GetPublicKey(request *GetPublicKeyRequest) (response *GetPublicKeyResponse, err error)

GetPublicKey This API is used to get the public key of an asymmetric KMS key (which must be enabled). With the public key, you can encrypt messages and verify signatures.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) GetPublicKeyWithContext 

func (c *Client) GetPublicKeyWithContext(ctx context.Context, request *GetPublicKeyRequest) (response *GetPublicKeyResponse, err error)

GetPublicKey This API is used to get the public key of an asymmetric KMS key (which must be enabled). With the public key, you can encrypt messages and verify signatures.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) GetRegions 

func (c *Client) GetRegions(request *GetRegionsRequest) (response *GetRegionsResponse, err error)

GetRegions This API is used to return all regions support KMS service.

error code that may be returned: 

INTERNALERROR = "InternalError"

func (*Client) GetRegionsWithContext 

func (c *Client) GetRegionsWithContext(ctx context.Context, request *GetRegionsRequest) (response *GetRegionsResponse, err error)

GetRegions This API is used to return all regions support KMS service.

error code that may be returned: 

INTERNALERROR = "InternalError"

func (*Client) GetServiceStatus 

func (c *Client) GetServiceStatus(request *GetServiceStatusRequest) (response *GetServiceStatusResponse, err error)

GetServiceStatus Used to query whether the user has activated the KMS service.

error code that may be returned: 

INTERNALERROR = "InternalError"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) GetServiceStatusWithContext 

func (c *Client) GetServiceStatusWithContext(ctx context.Context, request *GetServiceStatusRequest) (response *GetServiceStatusResponse, err error)

GetServiceStatus Used to query whether the user has activated the KMS service.

error code that may be returned: 

INTERNALERROR = "InternalError"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) ImportKeyMaterial 

func (c *Client) ImportKeyMaterial(request *ImportKeyMaterialRequest) (response *ImportKeyMaterialResponse, err error)

ImportKeyMaterial This API is used to import key material into an EXTERNAL CMK. The key obtained through the `GetParametersForImport` API is used to encrypt the key material. You can only reimport the same key material into the specified CMK and set a new expiration time. After the CMK key material is imported, it cannot be replaced. After the key material is expired or deleted, the CMK will remain unavailable until the same key material is reimported. CMKs are independent, which means that the same key material can be imported into different CMKs, but data encrypted by one CMK cannot be decrypted by another one.

Key material can only be imported into CMKs in `Enabled` and `PendingImport` status.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_DECRYPTMATERIALERROR = "InvalidParameter.DecryptMaterialError"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
INVALIDPARAMETERVALUE_MATERIALNOTMATCH = "InvalidParameterValue.MaterialNotMatch"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"
RESOURCEUNAVAILABLE_TOKENEXPIRED = "ResourceUnavailable.TokenExpired"
UNSUPPORTEDOPERATION_NOTEXTERNALCMK = "UnsupportedOperation.NotExternalCmk"
UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"

func (*Client) ImportKeyMaterialWithContext 

func (c *Client) ImportKeyMaterialWithContext(ctx context.Context, request *ImportKeyMaterialRequest) (response *ImportKeyMaterialResponse, err error)

ImportKeyMaterial This API is used to import key material into an EXTERNAL CMK. The key obtained through the `GetParametersForImport` API is used to encrypt the key material. You can only reimport the same key material into the specified CMK and set a new expiration time. After the CMK key material is imported, it cannot be replaced. After the key material is expired or deleted, the CMK will remain unavailable until the same key material is reimported. CMKs are independent, which means that the same key material can be imported into different CMKs, but data encrypted by one CMK cannot be decrypted by another one.

Key material can only be imported into CMKs in `Enabled` and `PendingImport` status.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_DECRYPTMATERIALERROR = "InvalidParameter.DecryptMaterialError"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
INVALIDPARAMETERVALUE_MATERIALNOTMATCH = "InvalidParameterValue.MaterialNotMatch"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"
RESOURCEUNAVAILABLE_TOKENEXPIRED = "ResourceUnavailable.TokenExpired"
UNSUPPORTEDOPERATION_NOTEXTERNALCMK = "UnsupportedOperation.NotExternalCmk"
UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"

func (*Client) ListAlgorithms 

func (c *Client) ListAlgorithms(request *ListAlgorithmsRequest) (response *ListAlgorithmsResponse, err error)

ListAlgorithms This API is used to list the encryption methods supported in the current region.

error code that may be returned: 

INTERNALERROR = "InternalError"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) ListAlgorithmsWithContext 

func (c *Client) ListAlgorithmsWithContext(ctx context.Context, request *ListAlgorithmsRequest) (response *ListAlgorithmsResponse, err error)

ListAlgorithms This API is used to list the encryption methods supported in the current region.

error code that may be returned: 

INTERNALERROR = "InternalError"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) ListKeyDetail 

func (c *Client) ListKeyDetail(request *ListKeyDetailRequest) (response *ListKeyDetailResponse, err error)

ListKeyDetail Get the master key list details according to the specified Offset and Limit.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDHSMCLUSTERID = "InvalidParameterValue.InvalidHsmClusterId"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) ListKeyDetailWithContext 

func (c *Client) ListKeyDetailWithContext(ctx context.Context, request *ListKeyDetailRequest) (response *ListKeyDetailResponse, err error)

ListKeyDetail Get the master key list details according to the specified Offset and Limit.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDHSMCLUSTERID = "InvalidParameterValue.InvalidHsmClusterId"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) ListKeys 

func (c *Client) ListKeys(request *ListKeysRequest) (response *ListKeysResponse, err error)

ListKeys This API is used to list the KeyIds of CMKs in `Enabled`, `Disabled`, and `PendingImport` status under the account.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDHSMCLUSTERID = "InvalidParameterValue.InvalidHsmClusterId"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) ListKeysWithContext 

func (c *Client) ListKeysWithContext(ctx context.Context, request *ListKeysRequest) (response *ListKeysResponse, err error)

ListKeys This API is used to list the KeyIds of CMKs in `Enabled`, `Disabled`, and `PendingImport` status under the account.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDHSMCLUSTERID = "InvalidParameterValue.InvalidHsmClusterId"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) OverwriteWhiteBoxDeviceFingerprints 

func (c *Client) OverwriteWhiteBoxDeviceFingerprints(request *OverwriteWhiteBoxDeviceFingerprintsRequest) (response *OverwriteWhiteBoxDeviceFingerprintsResponse, err error)

OverwriteWhiteBoxDeviceFingerprints This API is used to overwrite the device fingerprint information of a specified key.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
LIMITEXCEEDED_FINGERPRINTSLIMITEXCEEDED = "LimitExceeded.FingerprintsLimitExceeded"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) OverwriteWhiteBoxDeviceFingerprintsWithContext 

func (c *Client) OverwriteWhiteBoxDeviceFingerprintsWithContext(ctx context.Context, request *OverwriteWhiteBoxDeviceFingerprintsRequest) (response *OverwriteWhiteBoxDeviceFingerprintsResponse, err error)

OverwriteWhiteBoxDeviceFingerprints This API is used to overwrite the device fingerprint information of a specified key.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
LIMITEXCEEDED_FINGERPRINTSLIMITEXCEEDED = "LimitExceeded.FingerprintsLimitExceeded"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) PostQuantumCryptoDecrypt 

func (c *Client) PostQuantumCryptoDecrypt(request *PostQuantumCryptoDecryptRequest) (response *PostQuantumCryptoDecryptResponse, err error)

PostQuantumCryptoDecrypt u200dThis API u200dis used to decrypt ciphertext using post-quantum cryptography (PQC) algorithm, and return the plaintext.

error code that may be returned: 

FAILEDOPERATION_ENCRYPTIONERROR = "FailedOperation.EncryptionError"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDCIPHERTEXT = "InvalidParameterValue.InvalidCiphertext"
RESOURCEUNAVAILABLE_CMKDISABLED = "ResourceUnavailable.CmkDisabled"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) PostQuantumCryptoDecryptWithContext 

func (c *Client) PostQuantumCryptoDecryptWithContext(ctx context.Context, request *PostQuantumCryptoDecryptRequest) (response *PostQuantumCryptoDecryptResponse, err error)

PostQuantumCryptoDecrypt u200dThis API u200dis used to decrypt ciphertext using post-quantum cryptography (PQC) algorithm, and return the plaintext.

error code that may be returned: 

FAILEDOPERATION_ENCRYPTIONERROR = "FailedOperation.EncryptionError"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDCIPHERTEXT = "InvalidParameterValue.InvalidCiphertext"
RESOURCEUNAVAILABLE_CMKDISABLED = "ResourceUnavailable.CmkDisabled"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) PostQuantumCryptoEncrypt 

func (c *Client) PostQuantumCryptoEncrypt(request *PostQuantumCryptoEncryptRequest) (response *PostQuantumCryptoEncryptResponse, err error)

PostQuantumCryptoEncrypt u200dThis API u200dis used to encrypt using PQC. It supports up to 4 KB of data. It is applicable for encryption of database passwords, RSA keys, or other sensitive information. You can also apply `DataKey` generated by API `GenerateDataKey` to encrypt or decrypt your local data.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
INVALIDPARAMETERVALUE_INVALIDPLAINTEXT = "InvalidParameterValue.InvalidPlaintext"
RESOURCEUNAVAILABLE_CMKARCHIVED = "ResourceUnavailable.CmkArchived"
RESOURCEUNAVAILABLE_CMKDISABLED = "ResourceUnavailable.CmkDisabled"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) PostQuantumCryptoEncryptWithContext 

func (c *Client) PostQuantumCryptoEncryptWithContext(ctx context.Context, request *PostQuantumCryptoEncryptRequest) (response *PostQuantumCryptoEncryptResponse, err error)

PostQuantumCryptoEncrypt u200dThis API u200dis used to encrypt using PQC. It supports up to 4 KB of data. It is applicable for encryption of database passwords, RSA keys, or other sensitive information. You can also apply `DataKey` generated by API `GenerateDataKey` to encrypt or decrypt your local data.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
INVALIDPARAMETERVALUE_INVALIDPLAINTEXT = "InvalidParameterValue.InvalidPlaintext"
RESOURCEUNAVAILABLE_CMKARCHIVED = "ResourceUnavailable.CmkArchived"
RESOURCEUNAVAILABLE_CMKDISABLED = "ResourceUnavailable.CmkDisabled"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) PostQuantumCryptoSign 

func (c *Client) PostQuantumCryptoSign(request *PostQuantumCryptoSignRequest) (response *PostQuantumCryptoSignResponse, err error)

PostQuantumCryptoSign This API is used to sign u200dusing PQC.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
MISSINGPARAMETER = "MissingParameter"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"

func (*Client) PostQuantumCryptoSignWithContext 

func (c *Client) PostQuantumCryptoSignWithContext(ctx context.Context, request *PostQuantumCryptoSignRequest) (response *PostQuantumCryptoSignResponse, err error)

PostQuantumCryptoSign This API is used to sign u200dusing PQC.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
MISSINGPARAMETER = "MissingParameter"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"

func (*Client) PostQuantumCryptoVerify 

func (c *Client) PostQuantumCryptoVerify(request *PostQuantumCryptoVerifyRequest) (response *PostQuantumCryptoVerifyResponse, err error)

PostQuantumCryptoVerify This API is used to verify a signature u200dusing PQC.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"

func (*Client) PostQuantumCryptoVerifyWithContext 

func (c *Client) PostQuantumCryptoVerifyWithContext(ctx context.Context, request *PostQuantumCryptoVerifyRequest) (response *PostQuantumCryptoVerifyResponse, err error)

PostQuantumCryptoVerify This API is used to verify a signature u200dusing PQC.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"

func (*Client) ReEncrypt 

func (c *Client) ReEncrypt(request *ReEncryptRequest) (response *ReEncryptResponse, err error)

ReEncrypt Re-encrypt the ciphertext using the specified CMK.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDCIPHERTEXT = "InvalidParameterValue.InvalidCiphertext"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKDISABLED = "ResourceUnavailable.CmkDisabled"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) ReEncryptWithContext 

func (c *Client) ReEncryptWithContext(ctx context.Context, request *ReEncryptRequest) (response *ReEncryptResponse, err error)

ReEncrypt Re-encrypt the ciphertext using the specified CMK.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDCIPHERTEXT = "InvalidParameterValue.InvalidCiphertext"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKDISABLED = "ResourceUnavailable.CmkDisabled"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) ScheduleKeyDeletion 

func (c *Client) ScheduleKeyDeletion(request *ScheduleKeyDeletionRequest) (response *ScheduleKeyDeletionResponse, err error)

ScheduleKeyDeletion CMK planned deletion API, used to specify the time of CMK deletion, the optional time interval is [7,30] days

error code that may be returned: 

FAILEDOPERATION_CMKUSEDBYCLOUDPRODUCT = "FailedOperation.CmkUsedByCloudProduct"
INTERNALERROR = "InternalError"
INVALIDPARAMETER_INVALIDPENDINGWINDOWINDAYS = "InvalidParameter.InvalidPendingWindowInDays"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSHOULDBEDISABLED = "ResourceUnavailable.CmkShouldBeDisabled"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"

func (*Client) ScheduleKeyDeletionWithContext 

func (c *Client) ScheduleKeyDeletionWithContext(ctx context.Context, request *ScheduleKeyDeletionRequest) (response *ScheduleKeyDeletionResponse, err error)

ScheduleKeyDeletion CMK planned deletion API, used to specify the time of CMK deletion, the optional time interval is [7,30] days

error code that may be returned: 

FAILEDOPERATION_CMKUSEDBYCLOUDPRODUCT = "FailedOperation.CmkUsedByCloudProduct"
INTERNALERROR = "InternalError"
INVALIDPARAMETER_INVALIDPENDINGWINDOWINDAYS = "InvalidParameter.InvalidPendingWindowInDays"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSHOULDBEDISABLED = "ResourceUnavailable.CmkShouldBeDisabled"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"

func (*Client) SignByAsymmetricKey 

func (c *Client) SignByAsymmetricKey(request *SignByAsymmetricKeyRequest) (response *SignByAsymmetricKeyResponse, err error)

SignByAsymmetricKey This API is used to generate a signature with an asymmetric key.

Note that only when KeyUsage is `ASYMMETRIC_SIGN_VERIFY_${ALGORITHM}` (e.g., `ASYMMETRIC_SIGN_VERIFY_SM2` and `ASYMMETRIC_SIGN_VERIFY_ECC`), the key can be used for signing.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
MISSINGPARAMETER = "MissingParameter"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"

func (*Client) SignByAsymmetricKeyWithContext 

func (c *Client) SignByAsymmetricKeyWithContext(ctx context.Context, request *SignByAsymmetricKeyRequest) (response *SignByAsymmetricKeyResponse, err error)

SignByAsymmetricKey This API is used to generate a signature with an asymmetric key.

Note that only when KeyUsage is `ASYMMETRIC_SIGN_VERIFY_${ALGORITHM}` (e.g., `ASYMMETRIC_SIGN_VERIFY_SM2` and `ASYMMETRIC_SIGN_VERIFY_ECC`), the key can be used for signing.

error code that may be returned: 

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
MISSINGPARAMETER = "MissingParameter"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"

func (*Client) UnbindCloudResource 

func (c *Client) UnbindCloudResource(request *UnbindCloudResourceRequest) (response *UnbindCloudResourceResponse, err error)

UnbindCloudResource This API is used to unbind a key with a Tencent Cloud resource, indicating that the Tencent Cloud resource will not use the key any longer.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CLOUDRESOURCEBINDINGNOTFOUND = "ResourceUnavailable.CloudResourceBindingNotFound"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"

func (*Client) UnbindCloudResourceWithContext 

func (c *Client) UnbindCloudResourceWithContext(ctx context.Context, request *UnbindCloudResourceRequest) (response *UnbindCloudResourceResponse, err error)

UnbindCloudResource This API is used to unbind a key with a Tencent Cloud resource, indicating that the Tencent Cloud resource will not use the key any longer.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CLOUDRESOURCEBINDINGNOTFOUND = "ResourceUnavailable.CloudResourceBindingNotFound"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"

func (*Client) UpdateAlias 

func (c *Client) UpdateAlias(request *UpdateAliasRequest) (response *UpdateAliasResponse, err error)

UpdateAlias This API is used to modify the alias of a CMK. CMKs in `PendingDelete` status cannot be modified.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_ALIASALREADYEXISTS = "InvalidParameterValue.AliasAlreadyExists"
INVALIDPARAMETERVALUE_INVALIDALIAS = "InvalidParameterValue.InvalidAlias"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"

func (*Client) UpdateAliasWithContext 

func (c *Client) UpdateAliasWithContext(ctx context.Context, request *UpdateAliasRequest) (response *UpdateAliasResponse, err error)

UpdateAlias This API is used to modify the alias of a CMK. CMKs in `PendingDelete` status cannot be modified.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_ALIASALREADYEXISTS = "InvalidParameterValue.AliasAlreadyExists"
INVALIDPARAMETERVALUE_INVALIDALIAS = "InvalidParameterValue.InvalidAlias"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"

func (*Client) UpdateKeyDescription 

func (c *Client) UpdateKeyDescription(request *UpdateKeyDescriptionRequest) (response *UpdateKeyDescriptionResponse, err error)

UpdateKeyDescription This API is used to modify the description of the specified CMK. CMKs in `PendingDelete` status cannot be modified.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"

func (*Client) UpdateKeyDescriptionWithContext 

func (c *Client) UpdateKeyDescriptionWithContext(ctx context.Context, request *UpdateKeyDescriptionRequest) (response *UpdateKeyDescriptionResponse, err error)

UpdateKeyDescription This API is used to modify the description of the specified CMK. CMKs in `PendingDelete` status cannot be modified.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"

func (*Client) VerifyByAsymmetricKey 

func (c *Client) VerifyByAsymmetricKey(request *VerifyByAsymmetricKeyRequest) (response *VerifyByAsymmetricKeyResponse, err error)

VerifyByAsymmetricKey This API is used to verify a signature with an asymmetric key.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"

func (*Client) VerifyByAsymmetricKeyWithContext 

func (c *Client) VerifyByAsymmetricKeyWithContext(ctx context.Context, request *VerifyByAsymmetricKeyRequest) (response *VerifyByAsymmetricKeyResponse, err error)

VerifyByAsymmetricKey This API is used to verify a signature with an asymmetric key.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"

type CreateKeyRequest 

type CreateKeyRequest struct {
	*tchttp.BaseRequest

	// Unique alias that makes a key more recognizable and understandable. This parameter cannot be empty, can contain 1-60 letters, digits, `-`, and `_`, and must begin with a letter or digit. The `kms-` prefix is used for Tencent Cloud products.
	Alias *string `json:"Alias,omitnil,omitempty" name:"Alias"`

	// CMK description of up to 1,024 bytes in length
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// Defines the purpose of the key. The valid values are as follows: `ENCRYPT_DECRYPT` (default): creates a symmetric encryption/decryption key; `ASYMMETRIC_DECRYPT_RSA_2048`: creates an asymmetric encryption/decryption 2048-bit RSA key; `ASYMMETRIC_DECRYPT_SM2`: creates an asymmetric encryption/decryption SM2 key; `ASYMMETRIC_SIGN_VERIFY_SM2`: creates an asymmetric SM2 key for signature verification; `ASYMMETRIC_SIGN_VERIFY_ECC`: creates an asymmetric 2048-bit RSA key for signature verification; `ASYMMETRIC_SIGN_VERIFY_ECDSA384`: creates an asymmetric ECDSA384 key for signature verification. You can get a full list of supported key purposes and algorithms using the ListAlgorithms API.
	KeyUsage *string `json:"KeyUsage,omitnil,omitempty" name:"KeyUsage"`

	// Specifies the key type. Default value: 1. Valid value: 1 - default type, indicating that the CMK is created by KMS; 2 - EXTERNAL type, indicating that you need to import key material. For more information, please see the `GetParametersForImport` and `ImportKeyMaterial` API documents.
	Type *uint64 `json:"Type,omitnil,omitempty" name:"Type"`

	// Tag list
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`

	// ID of the HSM cluster. This field is only valid for Exclusive and Managed KMS instances.
	HsmClusterId *string `json:"HsmClusterId,omitnil,omitempty" name:"HsmClusterId"`
}

func NewCreateKeyRequest 

func NewCreateKeyRequest() (request *CreateKeyRequest)

func (*CreateKeyRequest) FromJsonString 

func (r *CreateKeyRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateKeyRequest) ToJsonString 

func (r *CreateKeyRequest) ToJsonString() string

type CreateKeyRequestParams 

type CreateKeyRequestParams struct {
	// Unique alias that makes a key more recognizable and understandable. This parameter cannot be empty, can contain 1-60 letters, digits, `-`, and `_`, and must begin with a letter or digit. The `kms-` prefix is used for Tencent Cloud products.
	Alias *string `json:"Alias,omitnil,omitempty" name:"Alias"`

	// CMK description of up to 1,024 bytes in length
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// Defines the purpose of the key. The valid values are as follows: `ENCRYPT_DECRYPT` (default): creates a symmetric encryption/decryption key; `ASYMMETRIC_DECRYPT_RSA_2048`: creates an asymmetric encryption/decryption 2048-bit RSA key; `ASYMMETRIC_DECRYPT_SM2`: creates an asymmetric encryption/decryption SM2 key; `ASYMMETRIC_SIGN_VERIFY_SM2`: creates an asymmetric SM2 key for signature verification; `ASYMMETRIC_SIGN_VERIFY_ECC`: creates an asymmetric 2048-bit RSA key for signature verification; `ASYMMETRIC_SIGN_VERIFY_ECDSA384`: creates an asymmetric ECDSA384 key for signature verification. You can get a full list of supported key purposes and algorithms using the ListAlgorithms API.
	KeyUsage *string `json:"KeyUsage,omitnil,omitempty" name:"KeyUsage"`

	// Specifies the key type. Default value: 1. Valid value: 1 - default type, indicating that the CMK is created by KMS; 2 - EXTERNAL type, indicating that you need to import key material. For more information, please see the `GetParametersForImport` and `ImportKeyMaterial` API documents.
	Type *uint64 `json:"Type,omitnil,omitempty" name:"Type"`

	// Tag list
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`

	// ID of the HSM cluster. This field is only valid for Exclusive and Managed KMS instances.
	HsmClusterId *string `json:"HsmClusterId,omitnil,omitempty" name:"HsmClusterId"`
}

Predefined struct for user

type CreateKeyResponse 

type CreateKeyResponse struct {
	*tchttp.BaseResponse
	Response *CreateKeyResponseParams `json:"Response"`
}

func NewCreateKeyResponse 

func NewCreateKeyResponse() (response *CreateKeyResponse)

func (*CreateKeyResponse) FromJsonString 

func (r *CreateKeyResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateKeyResponse) ToJsonString 

func (r *CreateKeyResponse) ToJsonString() string

type CreateKeyResponseParams 

type CreateKeyResponseParams struct {
	// Globally unique CMK ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// Alias that makes a key more recognizable and understandable
	Alias *string `json:"Alias,omitnil,omitempty" name:"Alias"`

	// Key creation time in UNIX timestamp format
	CreateTime *uint64 `json:"CreateTime,omitnil,omitempty" name:"CreateTime"`

	// CMK description
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// CMK status
	KeyState *string `json:"KeyState,omitnil,omitempty" name:"KeyState"`

	// CMK usage
	KeyUsage *string `json:"KeyUsage,omitnil,omitempty" name:"KeyUsage"`

	// Tag operation return code. 0: success; 1: internal error; 2: business processing error
	TagCode *uint64 `json:"TagCode,omitnil,omitempty" name:"TagCode"`

	// Tag operation return information
	TagMsg *string `json:"TagMsg,omitnil,omitempty" name:"TagMsg"`

	// ID of the HSM cluster. This field is only valid for Exclusive and Managed KMS instances.
	// Note: This field may return `null`, indicating that no valid value can be obtained.
	HsmClusterId *string `json:"HsmClusterId,omitnil,omitempty" name:"HsmClusterId"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type CreateWhiteBoxKeyRequest 

type CreateWhiteBoxKeyRequest struct {
	*tchttp.BaseRequest

	// Unique alias that makes a key more recognizable and understandable. This parameter should be 1 to 60 letters, digits, `-`, and `_`; it must begin with a letter or digit and cannot be left empty.
	Alias *string `json:"Alias,omitnil,omitempty" name:"Alias"`

	// All algorithm types for creating keys. Valid values: AES_256, SM4
	Algorithm *string `json:"Algorithm,omitnil,omitempty" name:"Algorithm"`

	// Key description of up to 1024 bytes
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// Tag list
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`
}

func NewCreateWhiteBoxKeyRequest 

func NewCreateWhiteBoxKeyRequest() (request *CreateWhiteBoxKeyRequest)

func (*CreateWhiteBoxKeyRequest) FromJsonString 

func (r *CreateWhiteBoxKeyRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateWhiteBoxKeyRequest) ToJsonString 

func (r *CreateWhiteBoxKeyRequest) ToJsonString() string

type CreateWhiteBoxKeyRequestParams 

type CreateWhiteBoxKeyRequestParams struct {
	// Unique alias that makes a key more recognizable and understandable. This parameter should be 1 to 60 letters, digits, `-`, and `_`; it must begin with a letter or digit and cannot be left empty.
	Alias *string `json:"Alias,omitnil,omitempty" name:"Alias"`

	// All algorithm types for creating keys. Valid values: AES_256, SM4
	Algorithm *string `json:"Algorithm,omitnil,omitempty" name:"Algorithm"`

	// Key description of up to 1024 bytes
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// Tag list
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`
}

Predefined struct for user

type CreateWhiteBoxKeyResponse 

type CreateWhiteBoxKeyResponse struct {
	*tchttp.BaseResponse
	Response *CreateWhiteBoxKeyResponseParams `json:"Response"`
}

func NewCreateWhiteBoxKeyResponse 

func NewCreateWhiteBoxKeyResponse() (response *CreateWhiteBoxKeyResponse)

func (*CreateWhiteBoxKeyResponse) FromJsonString 

func (r *CreateWhiteBoxKeyResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateWhiteBoxKeyResponse) ToJsonString 

func (r *CreateWhiteBoxKeyResponse) ToJsonString() string

type CreateWhiteBoxKeyResponseParams 

type CreateWhiteBoxKeyResponseParams struct {
	// Base64-encoded encryption key
	EncryptKey *string `json:"EncryptKey,omitnil,omitempty" name:"EncryptKey"`

	// Base64-encoded decryption key
	DecryptKey *string `json:"DecryptKey,omitnil,omitempty" name:"DecryptKey"`

	// Globally unique white-box key ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// Tag operation return code. 0: success; 1: internal error; 2: business processing error
	TagCode *uint64 `json:"TagCode,omitnil,omitempty" name:"TagCode"`

	// Tag operation return message
	TagMsg *string `json:"TagMsg,omitnil,omitempty" name:"TagMsg"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DecryptRequest 

type DecryptRequest struct {
	*tchttp.BaseRequest

	// The ciphertext data to be decrypted.
	CiphertextBlob *string `json:"CiphertextBlob,omitnil,omitempty" name:"CiphertextBlob"`

	// JSON string of key-value pair. If this parameter is specified for `Encrypt`, the same parameter needs to be provided when the `Decrypt` API is called. The maximum length is 1,024 bytes.
	EncryptionContext *string `json:"EncryptionContext,omitnil,omitempty" name:"EncryptionContext"`

	// PEM-encoded public key (2048-bit RSA/SM2 key), which can be used to encrypt the `Plaintext` returned. If this field is left empty, the `Plaintext` will not be encrypted.
	EncryptionPublicKey *string `json:"EncryptionPublicKey,omitnil,omitempty" name:"EncryptionPublicKey"`

	// Asymmetric encryption algorithm. Valid values: `SM2` (C1C3C2 ciphertext is returned), `SM2_C1C3C2_ASN1` (C1C3C2 ASN1 ciphertext is returned), `RSAES_PKCS1_V1_5`, `RSAES_OAEP_SHA_1`, and `RSAES_OAEP_SHA_256`. This field is used in combination with `EncryptionPublicKey` for encryption. If it is left empty, an SM2 public key will be used by default.
	EncryptionAlgorithm *string `json:"EncryptionAlgorithm,omitnil,omitempty" name:"EncryptionAlgorithm"`
}

func NewDecryptRequest 

func NewDecryptRequest() (request *DecryptRequest)

func (*DecryptRequest) FromJsonString 

func (r *DecryptRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DecryptRequest) ToJsonString 

func (r *DecryptRequest) ToJsonString() string

type DecryptRequestParams 

type DecryptRequestParams struct {
	// The ciphertext data to be decrypted.
	CiphertextBlob *string `json:"CiphertextBlob,omitnil,omitempty" name:"CiphertextBlob"`

	// JSON string of key-value pair. If this parameter is specified for `Encrypt`, the same parameter needs to be provided when the `Decrypt` API is called. The maximum length is 1,024 bytes.
	EncryptionContext *string `json:"EncryptionContext,omitnil,omitempty" name:"EncryptionContext"`

	// PEM-encoded public key (2048-bit RSA/SM2 key), which can be used to encrypt the `Plaintext` returned. If this field is left empty, the `Plaintext` will not be encrypted.
	EncryptionPublicKey *string `json:"EncryptionPublicKey,omitnil,omitempty" name:"EncryptionPublicKey"`

	// Asymmetric encryption algorithm. Valid values: `SM2` (C1C3C2 ciphertext is returned), `SM2_C1C3C2_ASN1` (C1C3C2 ASN1 ciphertext is returned), `RSAES_PKCS1_V1_5`, `RSAES_OAEP_SHA_1`, and `RSAES_OAEP_SHA_256`. This field is used in combination with `EncryptionPublicKey` for encryption. If it is left empty, an SM2 public key will be used by default.
	EncryptionAlgorithm *string `json:"EncryptionAlgorithm,omitnil,omitempty" name:"EncryptionAlgorithm"`
}

Predefined struct for user

type DecryptResponse 

type DecryptResponse struct {
	*tchttp.BaseResponse
	Response *DecryptResponseParams `json:"Response"`
}

func NewDecryptResponse 

func NewDecryptResponse() (response *DecryptResponse)

func (*DecryptResponse) FromJsonString 

func (r *DecryptResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DecryptResponse) ToJsonString 

func (r *DecryptResponse) ToJsonString() string

type DecryptResponseParams 

type DecryptResponseParams struct {
	// Globally unique CMK ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// If `EncryptionPublicKey` is left empty, a Base64-encoded ciphertext will be returned. To get the plaintext, you need to decode the ciphertext first.
	// If `EncryptionPublicKey` is specified, this field will return the Base64-encoded ciphertext encrypted with the specified public key. To get the plaintext, you need to decode the ciphertext and upload the corresponding private key.
	Plaintext *string `json:"Plaintext,omitnil,omitempty" name:"Plaintext"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DeleteImportedKeyMaterialRequest 

type DeleteImportedKeyMaterialRequest struct {
	*tchttp.BaseRequest

	// Specifies the EXTERNAL CMK for which to delete the key material.
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

func NewDeleteImportedKeyMaterialRequest 

func NewDeleteImportedKeyMaterialRequest() (request *DeleteImportedKeyMaterialRequest)

func (*DeleteImportedKeyMaterialRequest) FromJsonString 

func (r *DeleteImportedKeyMaterialRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteImportedKeyMaterialRequest) ToJsonString 

func (r *DeleteImportedKeyMaterialRequest) ToJsonString() string

type DeleteImportedKeyMaterialRequestParams 

type DeleteImportedKeyMaterialRequestParams struct {
	// Specifies the EXTERNAL CMK for which to delete the key material.
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

Predefined struct for user

type DeleteImportedKeyMaterialResponse 

type DeleteImportedKeyMaterialResponse struct {
	*tchttp.BaseResponse
	Response *DeleteImportedKeyMaterialResponseParams `json:"Response"`
}

func NewDeleteImportedKeyMaterialResponse 

func NewDeleteImportedKeyMaterialResponse() (response *DeleteImportedKeyMaterialResponse)

func (*DeleteImportedKeyMaterialResponse) FromJsonString 

func (r *DeleteImportedKeyMaterialResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteImportedKeyMaterialResponse) ToJsonString 

func (r *DeleteImportedKeyMaterialResponse) ToJsonString() string

type DeleteImportedKeyMaterialResponseParams 

type DeleteImportedKeyMaterialResponseParams struct {
	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DeleteWhiteBoxKeyRequest 

type DeleteWhiteBoxKeyRequest struct {
	*tchttp.BaseRequest

	// Globally unique white-box key ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

func NewDeleteWhiteBoxKeyRequest 

func NewDeleteWhiteBoxKeyRequest() (request *DeleteWhiteBoxKeyRequest)

func (*DeleteWhiteBoxKeyRequest) FromJsonString 

func (r *DeleteWhiteBoxKeyRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteWhiteBoxKeyRequest) ToJsonString 

func (r *DeleteWhiteBoxKeyRequest) ToJsonString() string

type DeleteWhiteBoxKeyRequestParams 

type DeleteWhiteBoxKeyRequestParams struct {
	// Globally unique white-box key ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

Predefined struct for user

type DeleteWhiteBoxKeyResponse 

type DeleteWhiteBoxKeyResponse struct {
	*tchttp.BaseResponse
	Response *DeleteWhiteBoxKeyResponseParams `json:"Response"`
}

func NewDeleteWhiteBoxKeyResponse 

func NewDeleteWhiteBoxKeyResponse() (response *DeleteWhiteBoxKeyResponse)

func (*DeleteWhiteBoxKeyResponse) FromJsonString 

func (r *DeleteWhiteBoxKeyResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DeleteWhiteBoxKeyResponse) ToJsonString 

func (r *DeleteWhiteBoxKeyResponse) ToJsonString() string

type DeleteWhiteBoxKeyResponseParams 

type DeleteWhiteBoxKeyResponseParams struct {
	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeKeyRequest 

type DescribeKeyRequest struct {
	*tchttp.BaseRequest

	// Globally unique CMK ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

func NewDescribeKeyRequest 

func NewDescribeKeyRequest() (request *DescribeKeyRequest)

func (*DescribeKeyRequest) FromJsonString 

func (r *DescribeKeyRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeKeyRequest) ToJsonString 

func (r *DescribeKeyRequest) ToJsonString() string

type DescribeKeyRequestParams 

type DescribeKeyRequestParams struct {
	// Globally unique CMK ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

Predefined struct for user

type DescribeKeyResponse 

type DescribeKeyResponse struct {
	*tchttp.BaseResponse
	Response *DescribeKeyResponseParams `json:"Response"`
}

func NewDescribeKeyResponse 

func NewDescribeKeyResponse() (response *DescribeKeyResponse)

func (*DescribeKeyResponse) FromJsonString 

func (r *DescribeKeyResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeKeyResponse) ToJsonString 

func (r *DescribeKeyResponse) ToJsonString() string

type DescribeKeyResponseParams 

type DescribeKeyResponseParams struct {
	// Key attribute information
	// Note: this field may return null, indicating that no valid values can be obtained.
	KeyMetadata *KeyMetadata `json:"KeyMetadata,omitnil,omitempty" name:"KeyMetadata"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeKeysRequest 

type DescribeKeysRequest struct {
	*tchttp.BaseRequest

	// List of IDs of the CMKs to be queried in batches. Up to 100 `KeyId` values are supported in one query.
	KeyIds []*string `json:"KeyIds,omitnil,omitempty" name:"KeyIds"`
}

func NewDescribeKeysRequest 

func NewDescribeKeysRequest() (request *DescribeKeysRequest)

func (*DescribeKeysRequest) FromJsonString 

func (r *DescribeKeysRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeKeysRequest) ToJsonString 

func (r *DescribeKeysRequest) ToJsonString() string

type DescribeKeysRequestParams 

type DescribeKeysRequestParams struct {
	// List of IDs of the CMKs to be queried in batches. Up to 100 `KeyId` values are supported in one query.
	KeyIds []*string `json:"KeyIds,omitnil,omitempty" name:"KeyIds"`
}

Predefined struct for user

type DescribeKeysResponse 

type DescribeKeysResponse struct {
	*tchttp.BaseResponse
	Response *DescribeKeysResponseParams `json:"Response"`
}

func NewDescribeKeysResponse 

func NewDescribeKeysResponse() (response *DescribeKeysResponse)

func (*DescribeKeysResponse) FromJsonString 

func (r *DescribeKeysResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeKeysResponse) ToJsonString 

func (r *DescribeKeysResponse) ToJsonString() string

type DescribeKeysResponseParams 

type DescribeKeysResponseParams struct {
	// List of returned attribute information
	// Note: this field may return null, indicating that no valid values can be obtained.
	KeyMetadatas []*KeyMetadata `json:"KeyMetadatas,omitnil,omitempty" name:"KeyMetadatas"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeWhiteBoxDecryptKeyRequest 

type DescribeWhiteBoxDecryptKeyRequest struct {
	*tchttp.BaseRequest

	// Globally unique white-box key ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

func NewDescribeWhiteBoxDecryptKeyRequest 

func NewDescribeWhiteBoxDecryptKeyRequest() (request *DescribeWhiteBoxDecryptKeyRequest)

func (*DescribeWhiteBoxDecryptKeyRequest) FromJsonString 

func (r *DescribeWhiteBoxDecryptKeyRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeWhiteBoxDecryptKeyRequest) ToJsonString 

func (r *DescribeWhiteBoxDecryptKeyRequest) ToJsonString() string

type DescribeWhiteBoxDecryptKeyRequestParams 

type DescribeWhiteBoxDecryptKeyRequestParams struct {
	// Globally unique white-box key ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

Predefined struct for user

type DescribeWhiteBoxDecryptKeyResponse 

type DescribeWhiteBoxDecryptKeyResponse struct {
	*tchttp.BaseResponse
	Response *DescribeWhiteBoxDecryptKeyResponseParams `json:"Response"`
}

func NewDescribeWhiteBoxDecryptKeyResponse 

func NewDescribeWhiteBoxDecryptKeyResponse() (response *DescribeWhiteBoxDecryptKeyResponse)

func (*DescribeWhiteBoxDecryptKeyResponse) FromJsonString 

func (r *DescribeWhiteBoxDecryptKeyResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeWhiteBoxDecryptKeyResponse) ToJsonString 

func (r *DescribeWhiteBoxDecryptKeyResponse) ToJsonString() string

type DescribeWhiteBoxDecryptKeyResponseParams 

type DescribeWhiteBoxDecryptKeyResponseParams struct {
	// Base64-encoded white-box decryption key
	DecryptKey *string `json:"DecryptKey,omitnil,omitempty" name:"DecryptKey"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeWhiteBoxDeviceFingerprintsRequest 

type DescribeWhiteBoxDeviceFingerprintsRequest struct {
	*tchttp.BaseRequest

	// White-box key ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

func NewDescribeWhiteBoxDeviceFingerprintsRequest 

func NewDescribeWhiteBoxDeviceFingerprintsRequest() (request *DescribeWhiteBoxDeviceFingerprintsRequest)

func (*DescribeWhiteBoxDeviceFingerprintsRequest) FromJsonString 

func (r *DescribeWhiteBoxDeviceFingerprintsRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeWhiteBoxDeviceFingerprintsRequest) ToJsonString 

func (r *DescribeWhiteBoxDeviceFingerprintsRequest) ToJsonString() string

type DescribeWhiteBoxDeviceFingerprintsRequestParams 

type DescribeWhiteBoxDeviceFingerprintsRequestParams struct {
	// White-box key ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

Predefined struct for user

type DescribeWhiteBoxDeviceFingerprintsResponse 

type DescribeWhiteBoxDeviceFingerprintsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeWhiteBoxDeviceFingerprintsResponseParams `json:"Response"`
}

func NewDescribeWhiteBoxDeviceFingerprintsResponse 

func NewDescribeWhiteBoxDeviceFingerprintsResponse() (response *DescribeWhiteBoxDeviceFingerprintsResponse)

func (*DescribeWhiteBoxDeviceFingerprintsResponse) FromJsonString 

func (r *DescribeWhiteBoxDeviceFingerprintsResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeWhiteBoxDeviceFingerprintsResponse) ToJsonString 

func (r *DescribeWhiteBoxDeviceFingerprintsResponse) ToJsonString() string

type DescribeWhiteBoxDeviceFingerprintsResponseParams 

type DescribeWhiteBoxDeviceFingerprintsResponseParams struct {
	// Device fingerprint list
	DeviceFingerprints []*DeviceFingerprint `json:"DeviceFingerprints,omitnil,omitempty" name:"DeviceFingerprints"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeWhiteBoxKeyDetailsRequest 

type DescribeWhiteBoxKeyDetailsRequest struct {
	*tchttp.BaseRequest

	// Filter: key status. 0: disabled, 1: enabled
	KeyStatus *int64 `json:"KeyStatus,omitnil,omitempty" name:"KeyStatus"`

	// This parameter has the same meaning of the `Offset` in an SQL query, indicating that this acquisition starts from the "No. Offset value" element of the array arranged in a certain order. The default value is 0.
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// This parameter has the same meaning of the `Limit` in an SQL query, indicating that up to `Limit` value elements can be obtained in this request. The default value is 0, indicating not to paginate.
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// Tag filter condition
	TagFilters []*TagFilter `json:"TagFilters,omitnil,omitempty" name:"TagFilters"`
}

func NewDescribeWhiteBoxKeyDetailsRequest 

func NewDescribeWhiteBoxKeyDetailsRequest() (request *DescribeWhiteBoxKeyDetailsRequest)

func (*DescribeWhiteBoxKeyDetailsRequest) FromJsonString 

func (r *DescribeWhiteBoxKeyDetailsRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeWhiteBoxKeyDetailsRequest) ToJsonString 

func (r *DescribeWhiteBoxKeyDetailsRequest) ToJsonString() string

type DescribeWhiteBoxKeyDetailsRequestParams 

type DescribeWhiteBoxKeyDetailsRequestParams struct {
	// Filter: key status. 0: disabled, 1: enabled
	KeyStatus *int64 `json:"KeyStatus,omitnil,omitempty" name:"KeyStatus"`

	// This parameter has the same meaning of the `Offset` in an SQL query, indicating that this acquisition starts from the "No. Offset value" element of the array arranged in a certain order. The default value is 0.
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// This parameter has the same meaning of the `Limit` in an SQL query, indicating that up to `Limit` value elements can be obtained in this request. The default value is 0, indicating not to paginate.
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// Tag filter condition
	TagFilters []*TagFilter `json:"TagFilters,omitnil,omitempty" name:"TagFilters"`
}

Predefined struct for user

type DescribeWhiteBoxKeyDetailsResponse 

type DescribeWhiteBoxKeyDetailsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeWhiteBoxKeyDetailsResponseParams `json:"Response"`
}

func NewDescribeWhiteBoxKeyDetailsResponse 

func NewDescribeWhiteBoxKeyDetailsResponse() (response *DescribeWhiteBoxKeyDetailsResponse)

func (*DescribeWhiteBoxKeyDetailsResponse) FromJsonString 

func (r *DescribeWhiteBoxKeyDetailsResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeWhiteBoxKeyDetailsResponse) ToJsonString 

func (r *DescribeWhiteBoxKeyDetailsResponse) ToJsonString() string

type DescribeWhiteBoxKeyDetailsResponseParams 

type DescribeWhiteBoxKeyDetailsResponseParams struct {
	// White-box key information list
	KeyInfos []*WhiteboxKeyInfo `json:"KeyInfos,omitnil,omitempty" name:"KeyInfos"`

	// Total white-box keys.
	// Note: This field may return null, indicating that no valid values can be obtained.
	TotalCount *uint64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeWhiteBoxKeyRequest 

type DescribeWhiteBoxKeyRequest struct {
	*tchttp.BaseRequest

	// Globally unique white-box key ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

func NewDescribeWhiteBoxKeyRequest 

func NewDescribeWhiteBoxKeyRequest() (request *DescribeWhiteBoxKeyRequest)

func (*DescribeWhiteBoxKeyRequest) FromJsonString 

func (r *DescribeWhiteBoxKeyRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeWhiteBoxKeyRequest) ToJsonString 

func (r *DescribeWhiteBoxKeyRequest) ToJsonString() string

type DescribeWhiteBoxKeyRequestParams 

type DescribeWhiteBoxKeyRequestParams struct {
	// Globally unique white-box key ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

Predefined struct for user

type DescribeWhiteBoxKeyResponse 

type DescribeWhiteBoxKeyResponse struct {
	*tchttp.BaseResponse
	Response *DescribeWhiteBoxKeyResponseParams `json:"Response"`
}

func NewDescribeWhiteBoxKeyResponse 

func NewDescribeWhiteBoxKeyResponse() (response *DescribeWhiteBoxKeyResponse)

func (*DescribeWhiteBoxKeyResponse) FromJsonString 

func (r *DescribeWhiteBoxKeyResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeWhiteBoxKeyResponse) ToJsonString 

func (r *DescribeWhiteBoxKeyResponse) ToJsonString() string

type DescribeWhiteBoxKeyResponseParams 

type DescribeWhiteBoxKeyResponseParams struct {
	// White-box key information
	KeyInfo *WhiteboxKeyInfo `json:"KeyInfo,omitnil,omitempty" name:"KeyInfo"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeWhiteBoxServiceStatusRequest 

type DescribeWhiteBoxServiceStatusRequest struct {
	*tchttp.BaseRequest
}

func NewDescribeWhiteBoxServiceStatusRequest 

func NewDescribeWhiteBoxServiceStatusRequest() (request *DescribeWhiteBoxServiceStatusRequest)

func (*DescribeWhiteBoxServiceStatusRequest) FromJsonString 

func (r *DescribeWhiteBoxServiceStatusRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeWhiteBoxServiceStatusRequest) ToJsonString 

func (r *DescribeWhiteBoxServiceStatusRequest) ToJsonString() string

type DescribeWhiteBoxServiceStatusRequestParams 

type DescribeWhiteBoxServiceStatusRequestParams struct {
}

Predefined struct for user

type DescribeWhiteBoxServiceStatusResponse 

type DescribeWhiteBoxServiceStatusResponse struct {
	*tchttp.BaseResponse
	Response *DescribeWhiteBoxServiceStatusResponseParams `json:"Response"`
}

func NewDescribeWhiteBoxServiceStatusResponse 

func NewDescribeWhiteBoxServiceStatusResponse() (response *DescribeWhiteBoxServiceStatusResponse)

func (*DescribeWhiteBoxServiceStatusResponse) FromJsonString 

func (r *DescribeWhiteBoxServiceStatusResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeWhiteBoxServiceStatusResponse) ToJsonString 

func (r *DescribeWhiteBoxServiceStatusResponse) ToJsonString() string

type DescribeWhiteBoxServiceStatusResponseParams 

type DescribeWhiteBoxServiceStatusResponseParams struct {
	// Whether the user's white-box key service is available
	ServiceEnabled *bool `json:"ServiceEnabled,omitnil,omitempty" name:"ServiceEnabled"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DeviceFingerprint 

type DeviceFingerprint struct {
	// Fingerprint information collected by device fingerprint collector. Its format must be in the following regular expression: ^[0-9a-f]{8}[\-][0-9a-f]{14}[\-][0-9a-f]{14}[\-][0-9a-f]{14}[\-][0-9a-f]{16}$
	Identity *string `json:"Identity,omitnil,omitempty" name:"Identity"`

	// Description, such as IP and device name. Length limit: 1,024 bytes
	// Note: this field may return null, indicating that no valid values can be obtained.
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`
}

type DisableKeyRequest 

type DisableKeyRequest struct {
	*tchttp.BaseRequest

	// Unique CMK ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

func NewDisableKeyRequest 

func NewDisableKeyRequest() (request *DisableKeyRequest)

func (*DisableKeyRequest) FromJsonString 

func (r *DisableKeyRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DisableKeyRequest) ToJsonString 

func (r *DisableKeyRequest) ToJsonString() string

type DisableKeyRequestParams 

type DisableKeyRequestParams struct {
	// Unique CMK ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

Predefined struct for user

type DisableKeyResponse 

type DisableKeyResponse struct {
	*tchttp.BaseResponse
	Response *DisableKeyResponseParams `json:"Response"`
}

func NewDisableKeyResponse 

func NewDisableKeyResponse() (response *DisableKeyResponse)

func (*DisableKeyResponse) FromJsonString 

func (r *DisableKeyResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DisableKeyResponse) ToJsonString 

func (r *DisableKeyResponse) ToJsonString() string

type DisableKeyResponseParams 

type DisableKeyResponseParams struct {
	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DisableKeyRotationRequest 

type DisableKeyRotationRequest struct {
	*tchttp.BaseRequest

	// Unique CMK ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

func NewDisableKeyRotationRequest 

func NewDisableKeyRotationRequest() (request *DisableKeyRotationRequest)

func (*DisableKeyRotationRequest) FromJsonString 

func (r *DisableKeyRotationRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DisableKeyRotationRequest) ToJsonString 

func (r *DisableKeyRotationRequest) ToJsonString() string

type DisableKeyRotationRequestParams 

type DisableKeyRotationRequestParams struct {
	// Unique CMK ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

Predefined struct for user

type DisableKeyRotationResponse 

type DisableKeyRotationResponse struct {
	*tchttp.BaseResponse
	Response *DisableKeyRotationResponseParams `json:"Response"`
}

func NewDisableKeyRotationResponse 

func NewDisableKeyRotationResponse() (response *DisableKeyRotationResponse)

func (*DisableKeyRotationResponse) FromJsonString 

func (r *DisableKeyRotationResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DisableKeyRotationResponse) ToJsonString 

func (r *DisableKeyRotationResponse) ToJsonString() string

type DisableKeyRotationResponseParams 

type DisableKeyRotationResponseParams struct {
	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DisableKeysRequest 

type DisableKeysRequest struct {
	*tchttp.BaseRequest

	// List of IDs of the CMKs to be disabled in batches. Up to 100 CMKs are supported at a time
	KeyIds []*string `json:"KeyIds,omitnil,omitempty" name:"KeyIds"`
}

func NewDisableKeysRequest 

func NewDisableKeysRequest() (request *DisableKeysRequest)

func (*DisableKeysRequest) FromJsonString 

func (r *DisableKeysRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DisableKeysRequest) ToJsonString 

func (r *DisableKeysRequest) ToJsonString() string

type DisableKeysRequestParams 

type DisableKeysRequestParams struct {
	// List of IDs of the CMKs to be disabled in batches. Up to 100 CMKs are supported at a time
	KeyIds []*string `json:"KeyIds,omitnil,omitempty" name:"KeyIds"`
}

Predefined struct for user

type DisableKeysResponse 

type DisableKeysResponse struct {
	*tchttp.BaseResponse
	Response *DisableKeysResponseParams `json:"Response"`
}

func NewDisableKeysResponse 

func NewDisableKeysResponse() (response *DisableKeysResponse)

func (*DisableKeysResponse) FromJsonString 

func (r *DisableKeysResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DisableKeysResponse) ToJsonString 

func (r *DisableKeysResponse) ToJsonString() string

type DisableKeysResponseParams 

type DisableKeysResponseParams struct {
	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DisableWhiteBoxKeyRequest 

type DisableWhiteBoxKeyRequest struct {
	*tchttp.BaseRequest

	// Globally unique white-box key ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

func NewDisableWhiteBoxKeyRequest 

func NewDisableWhiteBoxKeyRequest() (request *DisableWhiteBoxKeyRequest)

func (*DisableWhiteBoxKeyRequest) FromJsonString 

func (r *DisableWhiteBoxKeyRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DisableWhiteBoxKeyRequest) ToJsonString 

func (r *DisableWhiteBoxKeyRequest) ToJsonString() string

type DisableWhiteBoxKeyRequestParams 

type DisableWhiteBoxKeyRequestParams struct {
	// Globally unique white-box key ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

Predefined struct for user

type DisableWhiteBoxKeyResponse 

type DisableWhiteBoxKeyResponse struct {
	*tchttp.BaseResponse
	Response *DisableWhiteBoxKeyResponseParams `json:"Response"`
}

func NewDisableWhiteBoxKeyResponse 

func NewDisableWhiteBoxKeyResponse() (response *DisableWhiteBoxKeyResponse)

func (*DisableWhiteBoxKeyResponse) FromJsonString 

func (r *DisableWhiteBoxKeyResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DisableWhiteBoxKeyResponse) ToJsonString 

func (r *DisableWhiteBoxKeyResponse) ToJsonString() string

type DisableWhiteBoxKeyResponseParams 

type DisableWhiteBoxKeyResponseParams struct {
	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DisableWhiteBoxKeysRequest 

type DisableWhiteBoxKeysRequest struct {
	*tchttp.BaseRequest

	// List of globally unique white-box key IDs. Note: you should make sure that all provided `KeyId` values are in valid format, unique, and actually exist. Up to 50 ones are allowed.
	KeyIds []*string `json:"KeyIds,omitnil,omitempty" name:"KeyIds"`
}

func NewDisableWhiteBoxKeysRequest 

func NewDisableWhiteBoxKeysRequest() (request *DisableWhiteBoxKeysRequest)

func (*DisableWhiteBoxKeysRequest) FromJsonString 

func (r *DisableWhiteBoxKeysRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DisableWhiteBoxKeysRequest) ToJsonString 

func (r *DisableWhiteBoxKeysRequest) ToJsonString() string

type DisableWhiteBoxKeysRequestParams 

type DisableWhiteBoxKeysRequestParams struct {
	// List of globally unique white-box key IDs. Note: you should make sure that all provided `KeyId` values are in valid format, unique, and actually exist. Up to 50 ones are allowed.
	KeyIds []*string `json:"KeyIds,omitnil,omitempty" name:"KeyIds"`
}

Predefined struct for user

type DisableWhiteBoxKeysResponse 

type DisableWhiteBoxKeysResponse struct {
	*tchttp.BaseResponse
	Response *DisableWhiteBoxKeysResponseParams `json:"Response"`
}

func NewDisableWhiteBoxKeysResponse 

func NewDisableWhiteBoxKeysResponse() (response *DisableWhiteBoxKeysResponse)

func (*DisableWhiteBoxKeysResponse) FromJsonString 

func (r *DisableWhiteBoxKeysResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DisableWhiteBoxKeysResponse) ToJsonString 

func (r *DisableWhiteBoxKeysResponse) ToJsonString() string

type DisableWhiteBoxKeysResponseParams 

type DisableWhiteBoxKeysResponseParams struct {
	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type EnableKeyRequest 

type EnableKeyRequest struct {
	*tchttp.BaseRequest

	// Unique CMK ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

func NewEnableKeyRequest 

func NewEnableKeyRequest() (request *EnableKeyRequest)

func (*EnableKeyRequest) FromJsonString 

func (r *EnableKeyRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*EnableKeyRequest) ToJsonString 

func (r *EnableKeyRequest) ToJsonString() string

type EnableKeyRequestParams 

type EnableKeyRequestParams struct {
	// Unique CMK ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

Predefined struct for user

type EnableKeyResponse 

type EnableKeyResponse struct {
	*tchttp.BaseResponse
	Response *EnableKeyResponseParams `json:"Response"`
}

func NewEnableKeyResponse 

func NewEnableKeyResponse() (response *EnableKeyResponse)

func (*EnableKeyResponse) FromJsonString 

func (r *EnableKeyResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*EnableKeyResponse) ToJsonString 

func (r *EnableKeyResponse) ToJsonString() string

type EnableKeyResponseParams 

type EnableKeyResponseParams struct {
	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type EnableKeyRotationRequest 

type EnableKeyRotationRequest struct {
	*tchttp.BaseRequest

	// Unique CMK ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// The interval between each key rotation in days. Value range: 7 - 365 (default).
	RotateDays *uint64 `json:"RotateDays,omitnil,omitempty" name:"RotateDays"`
}

func NewEnableKeyRotationRequest 

func NewEnableKeyRotationRequest() (request *EnableKeyRotationRequest)

func (*EnableKeyRotationRequest) FromJsonString 

func (r *EnableKeyRotationRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*EnableKeyRotationRequest) ToJsonString 

func (r *EnableKeyRotationRequest) ToJsonString() string

type EnableKeyRotationRequestParams 

type EnableKeyRotationRequestParams struct {
	// Unique CMK ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// The interval between each key rotation in days. Value range: 7 - 365 (default).
	RotateDays *uint64 `json:"RotateDays,omitnil,omitempty" name:"RotateDays"`
}

Predefined struct for user

type EnableKeyRotationResponse 

type EnableKeyRotationResponse struct {
	*tchttp.BaseResponse
	Response *EnableKeyRotationResponseParams `json:"Response"`
}

func NewEnableKeyRotationResponse 

func NewEnableKeyRotationResponse() (response *EnableKeyRotationResponse)

func (*EnableKeyRotationResponse) FromJsonString 

func (r *EnableKeyRotationResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*EnableKeyRotationResponse) ToJsonString 

func (r *EnableKeyRotationResponse) ToJsonString() string

type EnableKeyRotationResponseParams 

type EnableKeyRotationResponseParams struct {
	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type EnableKeysRequest 

type EnableKeysRequest struct {
	*tchttp.BaseRequest

	// List of IDs of the CMKs to be enabled in batches. Up to 100 CMKs are supported at a time
	KeyIds []*string `json:"KeyIds,omitnil,omitempty" name:"KeyIds"`
}

func NewEnableKeysRequest 

func NewEnableKeysRequest() (request *EnableKeysRequest)

func (*EnableKeysRequest) FromJsonString 

func (r *EnableKeysRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*EnableKeysRequest) ToJsonString 

func (r *EnableKeysRequest) ToJsonString() string

type EnableKeysRequestParams 

type EnableKeysRequestParams struct {
	// List of IDs of the CMKs to be enabled in batches. Up to 100 CMKs are supported at a time
	KeyIds []*string `json:"KeyIds,omitnil,omitempty" name:"KeyIds"`
}

Predefined struct for user

type EnableKeysResponse 

type EnableKeysResponse struct {
	*tchttp.BaseResponse
	Response *EnableKeysResponseParams `json:"Response"`
}

func NewEnableKeysResponse 

func NewEnableKeysResponse() (response *EnableKeysResponse)

func (*EnableKeysResponse) FromJsonString 

func (r *EnableKeysResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*EnableKeysResponse) ToJsonString 

func (r *EnableKeysResponse) ToJsonString() string

type EnableKeysResponseParams 

type EnableKeysResponseParams struct {
	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type EnableWhiteBoxKeyRequest 

type EnableWhiteBoxKeyRequest struct {
	*tchttp.BaseRequest

	// Globally unique white-box key ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

func NewEnableWhiteBoxKeyRequest 

func NewEnableWhiteBoxKeyRequest() (request *EnableWhiteBoxKeyRequest)

func (*EnableWhiteBoxKeyRequest) FromJsonString 

func (r *EnableWhiteBoxKeyRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*EnableWhiteBoxKeyRequest) ToJsonString 

func (r *EnableWhiteBoxKeyRequest) ToJsonString() string

type EnableWhiteBoxKeyRequestParams 

type EnableWhiteBoxKeyRequestParams struct {
	// Globally unique white-box key ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

Predefined struct for user

type EnableWhiteBoxKeyResponse 

type EnableWhiteBoxKeyResponse struct {
	*tchttp.BaseResponse
	Response *EnableWhiteBoxKeyResponseParams `json:"Response"`
}

func NewEnableWhiteBoxKeyResponse 

func NewEnableWhiteBoxKeyResponse() (response *EnableWhiteBoxKeyResponse)

func (*EnableWhiteBoxKeyResponse) FromJsonString 

func (r *EnableWhiteBoxKeyResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*EnableWhiteBoxKeyResponse) ToJsonString 

func (r *EnableWhiteBoxKeyResponse) ToJsonString() string

type EnableWhiteBoxKeyResponseParams 

type EnableWhiteBoxKeyResponseParams struct {
	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type EnableWhiteBoxKeysRequest 

type EnableWhiteBoxKeysRequest struct {
	*tchttp.BaseRequest

	// List of globally unique white-box key IDs. Note: you should make sure that all provided `KeyId` values are in valid format, unique, and actually exist. Up to 50 ones are allowed.
	KeyIds []*string `json:"KeyIds,omitnil,omitempty" name:"KeyIds"`
}

func NewEnableWhiteBoxKeysRequest 

func NewEnableWhiteBoxKeysRequest() (request *EnableWhiteBoxKeysRequest)

func (*EnableWhiteBoxKeysRequest) FromJsonString 

func (r *EnableWhiteBoxKeysRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*EnableWhiteBoxKeysRequest) ToJsonString 

func (r *EnableWhiteBoxKeysRequest) ToJsonString() string

type EnableWhiteBoxKeysRequestParams 

type EnableWhiteBoxKeysRequestParams struct {
	// List of globally unique white-box key IDs. Note: you should make sure that all provided `KeyId` values are in valid format, unique, and actually exist. Up to 50 ones are allowed.
	KeyIds []*string `json:"KeyIds,omitnil,omitempty" name:"KeyIds"`
}

Predefined struct for user

type EnableWhiteBoxKeysResponse 

type EnableWhiteBoxKeysResponse struct {
	*tchttp.BaseResponse
	Response *EnableWhiteBoxKeysResponseParams `json:"Response"`
}

func NewEnableWhiteBoxKeysResponse 

func NewEnableWhiteBoxKeysResponse() (response *EnableWhiteBoxKeysResponse)

func (*EnableWhiteBoxKeysResponse) FromJsonString 

func (r *EnableWhiteBoxKeysResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*EnableWhiteBoxKeysResponse) ToJsonString 

func (r *EnableWhiteBoxKeysResponse) ToJsonString() string

type EnableWhiteBoxKeysResponseParams 

type EnableWhiteBoxKeysResponseParams struct {
	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type EncryptByWhiteBoxRequest 

type EncryptByWhiteBoxRequest struct {
	*tchttp.BaseRequest

	// Globally unique white-box key ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// Base64-encoded text to be encrypted. The size of the original text cannot exceed 4 KB.
	PlainText *string `json:"PlainText,omitnil,omitempty" name:"PlainText"`

	// Base64-encoded initialization vector of 16 bytes, which will be used by the encryption algorithm. If this parameter is not passed in, the backend service will generate a random one. You should save this value as a parameter for decryption.
	InitializationVector *string `json:"InitializationVector,omitnil,omitempty" name:"InitializationVector"`
}

func NewEncryptByWhiteBoxRequest 

func NewEncryptByWhiteBoxRequest() (request *EncryptByWhiteBoxRequest)

func (*EncryptByWhiteBoxRequest) FromJsonString 

func (r *EncryptByWhiteBoxRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*EncryptByWhiteBoxRequest) ToJsonString 

func (r *EncryptByWhiteBoxRequest) ToJsonString() string

type EncryptByWhiteBoxRequestParams 

type EncryptByWhiteBoxRequestParams struct {
	// Globally unique white-box key ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// Base64-encoded text to be encrypted. The size of the original text cannot exceed 4 KB.
	PlainText *string `json:"PlainText,omitnil,omitempty" name:"PlainText"`

	// Base64-encoded initialization vector of 16 bytes, which will be used by the encryption algorithm. If this parameter is not passed in, the backend service will generate a random one. You should save this value as a parameter for decryption.
	InitializationVector *string `json:"InitializationVector,omitnil,omitempty" name:"InitializationVector"`
}

Predefined struct for user

type EncryptByWhiteBoxResponse 

type EncryptByWhiteBoxResponse struct {
	*tchttp.BaseResponse
	Response *EncryptByWhiteBoxResponseParams `json:"Response"`
}

func NewEncryptByWhiteBoxResponse 

func NewEncryptByWhiteBoxResponse() (response *EncryptByWhiteBoxResponse)

func (*EncryptByWhiteBoxResponse) FromJsonString 

func (r *EncryptByWhiteBoxResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*EncryptByWhiteBoxResponse) ToJsonString 

func (r *EncryptByWhiteBoxResponse) ToJsonString() string

type EncryptByWhiteBoxResponseParams 

type EncryptByWhiteBoxResponseParams struct {
	// Base64-encoded initialization vector, which will be used by the encryption algorithm. If this parameter is passed in by the caller, it will be returned as-is; otherwise, the backend service will generate a random one and return it.
	InitializationVector *string `json:"InitializationVector,omitnil,omitempty" name:"InitializationVector"`

	// Base64-encoded ciphertext after encryption
	CipherText *string `json:"CipherText,omitnil,omitempty" name:"CipherText"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type EncryptRequest 

type EncryptRequest struct {
	*tchttp.BaseRequest

	// Globally unique ID of the CMK generated by calling the `CreateKey` API
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// Encrypted plaintext data. This field must be Base64-encoded. The maximum size of the original data is 4 KB
	Plaintext *string `json:"Plaintext,omitnil,omitempty" name:"Plaintext"`

	// JSON string of key-value pair. If this parameter is specified, the same parameter needs to be provided when the `Decrypt` API is called. It is up to 1,024 characters
	EncryptionContext *string `json:"EncryptionContext,omitnil,omitempty" name:"EncryptionContext"`
}

func NewEncryptRequest 

func NewEncryptRequest() (request *EncryptRequest)

func (*EncryptRequest) FromJsonString 

func (r *EncryptRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*EncryptRequest) ToJsonString 

func (r *EncryptRequest) ToJsonString() string

type EncryptRequestParams 

type EncryptRequestParams struct {
	// Globally unique ID of the CMK generated by calling the `CreateKey` API
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// Encrypted plaintext data. This field must be Base64-encoded. The maximum size of the original data is 4 KB
	Plaintext *string `json:"Plaintext,omitnil,omitempty" name:"Plaintext"`

	// JSON string of key-value pair. If this parameter is specified, the same parameter needs to be provided when the `Decrypt` API is called. It is up to 1,024 characters
	EncryptionContext *string `json:"EncryptionContext,omitnil,omitempty" name:"EncryptionContext"`
}

Predefined struct for user

type EncryptResponse 

type EncryptResponse struct {
	*tchttp.BaseResponse
	Response *EncryptResponseParams `json:"Response"`
}

func NewEncryptResponse 

func NewEncryptResponse() (response *EncryptResponse)

func (*EncryptResponse) FromJsonString 

func (r *EncryptResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*EncryptResponse) ToJsonString 

func (r *EncryptResponse) ToJsonString() string

type EncryptResponseParams 

type EncryptResponseParams struct {
	// Base64-encoded ciphertext, which is the encrypted information of the ciphertext and key. To get the plaintext, you need to pass in this field to the Decrypt API.
	CiphertextBlob *string `json:"CiphertextBlob,omitnil,omitempty" name:"CiphertextBlob"`

	// Globally unique ID of the CMK used for encryption
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type GenerateDataKeyRequest 

type GenerateDataKeyRequest struct {
	*tchttp.BaseRequest

	// Globally unique CMK ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// Specifies the encryption algorithm and size of the `DataKey`. Valid values: AES_128, AES_256. Either `KeySpec` or `NumberOfBytes` must be specified.
	KeySpec *string `json:"KeySpec,omitnil,omitempty" name:"KeySpec"`

	// Length of the `DataKey`. If both `NumberOfBytes` and `KeySpec` are specified, `NumberOfBytes` will prevail. Minimum value: 1; maximum value: 1024. Either `KeySpec` or `NumberOfBytes` must be specified.
	NumberOfBytes *uint64 `json:"NumberOfBytes,omitnil,omitempty" name:"NumberOfBytes"`

	// JSON string of key-value pair. If this field is used, the same string should be entered when the returned `DataKey` is decrypted.
	EncryptionContext *string `json:"EncryptionContext,omitnil,omitempty" name:"EncryptionContext"`

	// PEM-encoded public key (2048-bit RSA/SM2 key), which can be used to encrypt the `Plaintext` returned. If this field is left empty, the `Plaintext` will not be encrypted.
	EncryptionPublicKey *string `json:"EncryptionPublicKey,omitnil,omitempty" name:"EncryptionPublicKey"`

	// Asymmetric encryption algorithm. Valid values: `SM2` (C1C3C2 ciphertext is returned)`, `SM2_C1C3C2_ASN1` (C1C3C2 ASN1 ciphertext is returned), `RSAES_PKCS1_V1_5`, `RSAES_OAEP_SHA_1`, and `RSAES_OAEP_SHA_256`. This field is used in combination with `EncryptionPublicKey` for encryption. If it is left empty, an SM2 public key will be used by default.
	EncryptionAlgorithm *string `json:"EncryptionAlgorithm,omitnil,omitempty" name:"EncryptionAlgorithm"`
}

func NewGenerateDataKeyRequest 

func NewGenerateDataKeyRequest() (request *GenerateDataKeyRequest)

func (*GenerateDataKeyRequest) FromJsonString 

func (r *GenerateDataKeyRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GenerateDataKeyRequest) ToJsonString 

func (r *GenerateDataKeyRequest) ToJsonString() string

type GenerateDataKeyRequestParams 

type GenerateDataKeyRequestParams struct {
	// Globally unique CMK ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// Specifies the encryption algorithm and size of the `DataKey`. Valid values: AES_128, AES_256. Either `KeySpec` or `NumberOfBytes` must be specified.
	KeySpec *string `json:"KeySpec,omitnil,omitempty" name:"KeySpec"`

	// Length of the `DataKey`. If both `NumberOfBytes` and `KeySpec` are specified, `NumberOfBytes` will prevail. Minimum value: 1; maximum value: 1024. Either `KeySpec` or `NumberOfBytes` must be specified.
	NumberOfBytes *uint64 `json:"NumberOfBytes,omitnil,omitempty" name:"NumberOfBytes"`

	// JSON string of key-value pair. If this field is used, the same string should be entered when the returned `DataKey` is decrypted.
	EncryptionContext *string `json:"EncryptionContext,omitnil,omitempty" name:"EncryptionContext"`

	// PEM-encoded public key (2048-bit RSA/SM2 key), which can be used to encrypt the `Plaintext` returned. If this field is left empty, the `Plaintext` will not be encrypted.
	EncryptionPublicKey *string `json:"EncryptionPublicKey,omitnil,omitempty" name:"EncryptionPublicKey"`

	// Asymmetric encryption algorithm. Valid values: `SM2` (C1C3C2 ciphertext is returned)`, `SM2_C1C3C2_ASN1` (C1C3C2 ASN1 ciphertext is returned), `RSAES_PKCS1_V1_5`, `RSAES_OAEP_SHA_1`, and `RSAES_OAEP_SHA_256`. This field is used in combination with `EncryptionPublicKey` for encryption. If it is left empty, an SM2 public key will be used by default.
	EncryptionAlgorithm *string `json:"EncryptionAlgorithm,omitnil,omitempty" name:"EncryptionAlgorithm"`
}

Predefined struct for user

type GenerateDataKeyResponse 

type GenerateDataKeyResponse struct {
	*tchttp.BaseResponse
	Response *GenerateDataKeyResponseParams `json:"Response"`
}

func NewGenerateDataKeyResponse 

func NewGenerateDataKeyResponse() (response *GenerateDataKeyResponse)

func (*GenerateDataKeyResponse) FromJsonString 

func (r *GenerateDataKeyResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GenerateDataKeyResponse) ToJsonString 

func (r *GenerateDataKeyResponse) ToJsonString() string

type GenerateDataKeyResponseParams 

type GenerateDataKeyResponseParams struct {
	// Globally unique CMK ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// If `EncryptionPublicKey` is left empty, a Base64-encoded ciphertext will be returned. To get the plaintext, you need to decode the ciphertext first.
	// If `EncryptionPublicKey` is specified, this field will return the Base64-encoded ciphertext encrypted with the specified public key. To get the plaintext, you need to decode the ciphertext and upload the corresponding private key.
	Plaintext *string `json:"Plaintext,omitnil,omitempty" name:"Plaintext"`

	// Ciphertext of the data key, which should be kept by yourself. KMS does not host user data keys. You can call the `Decrypt` API to get the plaintext of the data key from `CiphertextBlob`.
	CiphertextBlob *string `json:"CiphertextBlob,omitnil,omitempty" name:"CiphertextBlob"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type GenerateRandomRequest 

type GenerateRandomRequest struct {
	*tchttp.BaseRequest

	// Length of the random number. Minimum value: 1. Maximum value: 1024
	NumberOfBytes *uint64 `json:"NumberOfBytes,omitnil,omitempty" name:"NumberOfBytes"`
}

func NewGenerateRandomRequest 

func NewGenerateRandomRequest() (request *GenerateRandomRequest)

func (*GenerateRandomRequest) FromJsonString 

func (r *GenerateRandomRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GenerateRandomRequest) ToJsonString 

func (r *GenerateRandomRequest) ToJsonString() string

type GenerateRandomRequestParams 

type GenerateRandomRequestParams struct {
	// Length of the random number. Minimum value: 1. Maximum value: 1024
	NumberOfBytes *uint64 `json:"NumberOfBytes,omitnil,omitempty" name:"NumberOfBytes"`
}

Predefined struct for user

type GenerateRandomResponse 

type GenerateRandomResponse struct {
	*tchttp.BaseResponse
	Response *GenerateRandomResponseParams `json:"Response"`
}

func NewGenerateRandomResponse 

func NewGenerateRandomResponse() (response *GenerateRandomResponse)

func (*GenerateRandomResponse) FromJsonString 

func (r *GenerateRandomResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GenerateRandomResponse) ToJsonString 

func (r *GenerateRandomResponse) ToJsonString() string

type GenerateRandomResponseParams 

type GenerateRandomResponseParams struct {
	// Base64-encoded plaintext of the randomly generated number. You need to Base64-decode it to get the plaintext.
	Plaintext *string `json:"Plaintext,omitnil,omitempty" name:"Plaintext"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type GetKeyRotationStatusRequest 

type GetKeyRotationStatusRequest struct {
	*tchttp.BaseRequest

	// Unique CMK ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

func NewGetKeyRotationStatusRequest 

func NewGetKeyRotationStatusRequest() (request *GetKeyRotationStatusRequest)

func (*GetKeyRotationStatusRequest) FromJsonString 

func (r *GetKeyRotationStatusRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetKeyRotationStatusRequest) ToJsonString 

func (r *GetKeyRotationStatusRequest) ToJsonString() string

type GetKeyRotationStatusRequestParams 

type GetKeyRotationStatusRequestParams struct {
	// Unique CMK ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

Predefined struct for user

type GetKeyRotationStatusResponse 

type GetKeyRotationStatusResponse struct {
	*tchttp.BaseResponse
	Response *GetKeyRotationStatusResponseParams `json:"Response"`
}

func NewGetKeyRotationStatusResponse 

func NewGetKeyRotationStatusResponse() (response *GetKeyRotationStatusResponse)

func (*GetKeyRotationStatusResponse) FromJsonString 

func (r *GetKeyRotationStatusResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetKeyRotationStatusResponse) ToJsonString 

func (r *GetKeyRotationStatusResponse) ToJsonString() string

type GetKeyRotationStatusResponseParams 

type GetKeyRotationStatusResponseParams struct {
	// Whether key rotation is enabled
	KeyRotationEnabled *bool `json:"KeyRotationEnabled,omitnil,omitempty" name:"KeyRotationEnabled"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type GetParametersForImportRequest 

type GetParametersForImportRequest struct {
	*tchttp.BaseRequest

	// Unique ID of a CMK. The CMK for which to get the key parameters must be of the `EXTERNAL` type, i.e., Type = 2 when the CMK is created by the `CreateKey` API.
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// Specifies the algorithm for key material encryption. Currently, `RSAES_PKCS1_V1_5`, `RSAES_OAEP_SHA_1`, and `RSAES_OAEP_SHA_256` are supported.
	WrappingAlgorithm *string `json:"WrappingAlgorithm,omitnil,omitempty" name:"WrappingAlgorithm"`

	// Specifies the type of wrapping key. Currently, only `RSA_2048` is supported.
	WrappingKeySpec *string `json:"WrappingKeySpec,omitnil,omitempty" name:"WrappingKeySpec"`
}

func NewGetParametersForImportRequest 

func NewGetParametersForImportRequest() (request *GetParametersForImportRequest)

func (*GetParametersForImportRequest) FromJsonString 

func (r *GetParametersForImportRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetParametersForImportRequest) ToJsonString 

func (r *GetParametersForImportRequest) ToJsonString() string

type GetParametersForImportRequestParams 

type GetParametersForImportRequestParams struct {
	// Unique ID of a CMK. The CMK for which to get the key parameters must be of the `EXTERNAL` type, i.e., Type = 2 when the CMK is created by the `CreateKey` API.
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// Specifies the algorithm for key material encryption. Currently, `RSAES_PKCS1_V1_5`, `RSAES_OAEP_SHA_1`, and `RSAES_OAEP_SHA_256` are supported.
	WrappingAlgorithm *string `json:"WrappingAlgorithm,omitnil,omitempty" name:"WrappingAlgorithm"`

	// Specifies the type of wrapping key. Currently, only `RSA_2048` is supported.
	WrappingKeySpec *string `json:"WrappingKeySpec,omitnil,omitempty" name:"WrappingKeySpec"`
}

Predefined struct for user

type GetParametersForImportResponse 

type GetParametersForImportResponse struct {
	*tchttp.BaseResponse
	Response *GetParametersForImportResponseParams `json:"Response"`
}

func NewGetParametersForImportResponse 

func NewGetParametersForImportResponse() (response *GetParametersForImportResponse)

func (*GetParametersForImportResponse) FromJsonString 

func (r *GetParametersForImportResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetParametersForImportResponse) ToJsonString 

func (r *GetParametersForImportResponse) ToJsonString() string

type GetParametersForImportResponseParams 

type GetParametersForImportResponseParams struct {
	// Unique ID of a CMK, which is used to specify the CMK into which to import key material.
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// The token required for importing key material, which is used as a parameter for `ImportKeyMaterial`.
	ImportToken *string `json:"ImportToken,omitnil,omitempty" name:"ImportToken"`

	// The Base64-encoded RSA public key used to encrypt key material before importing it with `ImportKeyMaterial`.
	PublicKey *string `json:"PublicKey,omitnil,omitempty" name:"PublicKey"`

	// Validity period of the token and public key. A token and public key can only be imported when they are valid. If they are expired, you will need to call the `GetParametersForImport` API again to get a new token and public key.
	ParametersValidTo *uint64 `json:"ParametersValidTo,omitnil,omitempty" name:"ParametersValidTo"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type GetPublicKeyRequest 

type GetPublicKeyRequest struct {
	*tchttp.BaseRequest

	// Unique CMK ID.
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

func NewGetPublicKeyRequest 

func NewGetPublicKeyRequest() (request *GetPublicKeyRequest)

func (*GetPublicKeyRequest) FromJsonString 

func (r *GetPublicKeyRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetPublicKeyRequest) ToJsonString 

func (r *GetPublicKeyRequest) ToJsonString() string

type GetPublicKeyRequestParams 

type GetPublicKeyRequestParams struct {
	// Unique CMK ID.
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

Predefined struct for user

type GetPublicKeyResponse 

type GetPublicKeyResponse struct {
	*tchttp.BaseResponse
	Response *GetPublicKeyResponseParams `json:"Response"`
}

func NewGetPublicKeyResponse 

func NewGetPublicKeyResponse() (response *GetPublicKeyResponse)

func (*GetPublicKeyResponse) FromJsonString 

func (r *GetPublicKeyResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetPublicKeyResponse) ToJsonString 

func (r *GetPublicKeyResponse) ToJsonString() string

type GetPublicKeyResponseParams 

type GetPublicKeyResponseParams struct {
	// Unique CMK ID.
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// Base64-encoded public key content.
	PublicKey *string `json:"PublicKey,omitnil,omitempty" name:"PublicKey"`

	// Public key content in PEM format.
	PublicKeyPem *string `json:"PublicKeyPem,omitnil,omitempty" name:"PublicKeyPem"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type GetRegionsRequest 

type GetRegionsRequest struct {
	*tchttp.BaseRequest
}

func NewGetRegionsRequest 

func NewGetRegionsRequest() (request *GetRegionsRequest)

func (*GetRegionsRequest) FromJsonString 

func (r *GetRegionsRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetRegionsRequest) ToJsonString 

func (r *GetRegionsRequest) ToJsonString() string

type GetRegionsRequestParams 

type GetRegionsRequestParams struct {
}

Predefined struct for user

type GetRegionsResponse 

type GetRegionsResponse struct {
	*tchttp.BaseResponse
	Response *GetRegionsResponseParams `json:"Response"`
}

func NewGetRegionsResponse 

func NewGetRegionsResponse() (response *GetRegionsResponse)

func (*GetRegionsResponse) FromJsonString 

func (r *GetRegionsResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetRegionsResponse) ToJsonString 

func (r *GetRegionsResponse) ToJsonString() string

type GetRegionsResponseParams 

type GetRegionsResponseParams struct {
	// The list of supported regions
	// Note: this field may return null, indicating that no valid values can be obtained.
	Regions []*string `json:"Regions,omitnil,omitempty" name:"Regions"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type GetServiceStatusRequest 

type GetServiceStatusRequest struct {
	*tchttp.BaseRequest
}

func NewGetServiceStatusRequest 

func NewGetServiceStatusRequest() (request *GetServiceStatusRequest)

func (*GetServiceStatusRequest) FromJsonString 

func (r *GetServiceStatusRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetServiceStatusRequest) ToJsonString 

func (r *GetServiceStatusRequest) ToJsonString() string

type GetServiceStatusRequestParams 

type GetServiceStatusRequestParams struct {
}

Predefined struct for user

type GetServiceStatusResponse 

type GetServiceStatusResponse struct {
	*tchttp.BaseResponse
	Response *GetServiceStatusResponseParams `json:"Response"`
}

func NewGetServiceStatusResponse 

func NewGetServiceStatusResponse() (response *GetServiceStatusResponse)

func (*GetServiceStatusResponse) FromJsonString 

func (r *GetServiceStatusResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*GetServiceStatusResponse) ToJsonString 

func (r *GetServiceStatusResponse) ToJsonString() string

type GetServiceStatusResponseParams 

type GetServiceStatusResponseParams struct {
	// Whether the KMS service has been activated. true: activated
	ServiceEnabled *bool `json:"ServiceEnabled,omitnil,omitempty" name:"ServiceEnabled"`

	// Service unavailability type. 0: not purchased; 1: normal; 2: suspended due to arrears; 3: resource released
	InvalidType *int64 `json:"InvalidType,omitnil,omitempty" name:"InvalidType"`

	// 0: Basic Edition, 1: Ultimate Edition
	UserLevel *uint64 `json:"UserLevel,omitnil,omitempty" name:"UserLevel"`

	// Expiration time of the KMS Ultimate edition. It’s represented in a Unix Epoch timestamp.
	// Note: This field may return null, indicating that no valid values can be obtained.
	ProExpireTime *uint64 `json:"ProExpireTime,omitnil,omitempty" name:"ProExpireTime"`

	// Whether to automatically renew Ultimate Edition. 0: no, 1: yes
	// Note: this field may return null, indicating that no valid values can be obtained.
	ProRenewFlag *uint64 `json:"ProRenewFlag,omitnil,omitempty" name:"ProRenewFlag"`

	// Unique ID of the Ultimate Edition purchase record. If the Ultimate Edition is not activated, the returned value will be null.
	// Note: this field may return null, indicating that no valid values can be obtained.
	ProResourceId *string `json:"ProResourceId,omitnil,omitempty" name:"ProResourceId"`

	// Whether to activate Managed KMS
	// Note: This field may return `null`, indicating that no valid value can be obtained.
	ExclusiveVSMEnabled *bool `json:"ExclusiveVSMEnabled,omitnil,omitempty" name:"ExclusiveVSMEnabled"`

	// Whether to activate Exclusive KMS
	// Note: This field may return `null`, indicating that no valid value can be obtained.
	ExclusiveHSMEnabled *bool `json:"ExclusiveHSMEnabled,omitnil,omitempty" name:"ExclusiveHSMEnabled"`

	// KMS subscription information.
	// Note: This field may return null, indicating that no valid values can be obtained.
	SubscriptionInfo *string `json:"SubscriptionInfo,omitnil,omitempty" name:"SubscriptionInfo"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ImportKeyMaterialRequest 

type ImportKeyMaterialRequest struct {
	*tchttp.BaseRequest

	// Base64-encoded key material that encrypted with the `PublicKey` returned by `GetParametersForImport`. For the KMS of SM-CRYPTO version, the length of the key material should be 128 bits, while for KMS of FIPS-compliant version, the length should be 256 bits.
	EncryptedKeyMaterial *string `json:"EncryptedKeyMaterial,omitnil,omitempty" name:"EncryptedKeyMaterial"`

	// Import token obtained by calling `GetParametersForImport`.
	ImportToken *string `json:"ImportToken,omitnil,omitempty" name:"ImportToken"`

	// Specifies the CMK into which to import key material, which must be the same as the one specified by `GetParametersForImport`.
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// Unix timestamp of the key material's expiration time. If this value is empty or 0, the key material will never expire. To specify the expiration time, it should be later than the current time. Maximum value: 2147443200.
	ValidTo *uint64 `json:"ValidTo,omitnil,omitempty" name:"ValidTo"`
}

func NewImportKeyMaterialRequest 

func NewImportKeyMaterialRequest() (request *ImportKeyMaterialRequest)

func (*ImportKeyMaterialRequest) FromJsonString 

func (r *ImportKeyMaterialRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ImportKeyMaterialRequest) ToJsonString 

func (r *ImportKeyMaterialRequest) ToJsonString() string

type ImportKeyMaterialRequestParams 

type ImportKeyMaterialRequestParams struct {
	// Base64-encoded key material that encrypted with the `PublicKey` returned by `GetParametersForImport`. For the KMS of SM-CRYPTO version, the length of the key material should be 128 bits, while for KMS of FIPS-compliant version, the length should be 256 bits.
	EncryptedKeyMaterial *string `json:"EncryptedKeyMaterial,omitnil,omitempty" name:"EncryptedKeyMaterial"`

	// Import token obtained by calling `GetParametersForImport`.
	ImportToken *string `json:"ImportToken,omitnil,omitempty" name:"ImportToken"`

	// Specifies the CMK into which to import key material, which must be the same as the one specified by `GetParametersForImport`.
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// Unix timestamp of the key material's expiration time. If this value is empty or 0, the key material will never expire. To specify the expiration time, it should be later than the current time. Maximum value: 2147443200.
	ValidTo *uint64 `json:"ValidTo,omitnil,omitempty" name:"ValidTo"`
}

Predefined struct for user

type ImportKeyMaterialResponse 

type ImportKeyMaterialResponse struct {
	*tchttp.BaseResponse
	Response *ImportKeyMaterialResponseParams `json:"Response"`
}

func NewImportKeyMaterialResponse 

func NewImportKeyMaterialResponse() (response *ImportKeyMaterialResponse)

func (*ImportKeyMaterialResponse) FromJsonString 

func (r *ImportKeyMaterialResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ImportKeyMaterialResponse) ToJsonString 

func (r *ImportKeyMaterialResponse) ToJsonString() string

type ImportKeyMaterialResponseParams 

type ImportKeyMaterialResponseParams struct {
	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type Key 

type Key struct {
	// Globally unique CMK ID.
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

type KeyMetadata 

type KeyMetadata struct {
	// Globally unique CMK ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// Alias that makes a key more recognizable and understandable
	Alias *string `json:"Alias,omitnil,omitempty" name:"Alias"`

	// Key creation time
	CreateTime *uint64 `json:"CreateTime,omitnil,omitempty" name:"CreateTime"`

	// CMK description
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// CMK status. Valid values: Enabled, Disabled, PendingDelete, PendingImport, Archived.
	KeyState *string `json:"KeyState,omitnil,omitempty" name:"KeyState"`

	// CMK purpose. Valid values: `ENCRYPT_DECRYPT`, `ASYMMETRIC_DECRYPT_RSA_2048`, `ASYMMETRIC_DECRYPT_SM2`, `ASYMMETRIC_SIGN_VERIFY_SM2`, `ASYMMETRIC_SIGN_VERIFY_RSA_2048`, and `ASYMMETRIC_SIGN_VERIFY_ECC`.
	KeyUsage *string `json:"KeyUsage,omitnil,omitempty" name:"KeyUsage"`

	// CMK type. 2: FIPS-compliant; 4: SM-CRYPTO
	Type *int64 `json:"Type,omitnil,omitempty" name:"Type"`

	// Creator
	CreatorUin *uint64 `json:"CreatorUin,omitnil,omitempty" name:"CreatorUin"`

	// Whether key rotation is enabled
	KeyRotationEnabled *bool `json:"KeyRotationEnabled,omitnil,omitempty" name:"KeyRotationEnabled"`

	// CMK creator. The value of this parameter is `user` if the CMK is created by the user, or the corresponding service name if it is created automatically by an authorized Tencent Cloud service.
	Owner *string `json:"Owner,omitnil,omitempty" name:"Owner"`

	// Time of next rotation if key rotation is enabled
	NextRotateTime *uint64 `json:"NextRotateTime,omitnil,omitempty" name:"NextRotateTime"`

	// Scheduled deletion time
	DeletionDate *uint64 `json:"DeletionDate,omitnil,omitempty" name:"DeletionDate"`

	// CMK key material type. TENCENT_KMS: created by KMS; EXTERNAL: imported by user.
	// Note: This field may return null, indicating that no valid values can be obtained.
	Origin *string `json:"Origin,omitnil,omitempty" name:"Origin"`

	// It's valid when `Origin` is `EXTERNAL`, indicating the expiration date of key material. 0 means valid forever.
	// Note: This field may return null, indicating that no valid values can be obtained.
	ValidTo *uint64 `json:"ValidTo,omitnil,omitempty" name:"ValidTo"`

	// Resource ID in the format of `creatorUin/$creatorUin/$keyId`.
	ResourceId *string `json:"ResourceId,omitnil,omitempty" name:"ResourceId"`

	// ID of the HSM cluster. This field is only valid for Exclusive and Managed KMS instances.
	// Note: This field may return `null`, indicating that no valid value can be obtained.
	HsmClusterId *string `json:"HsmClusterId,omitnil,omitempty" name:"HsmClusterId"`
}

type ListAlgorithmsRequest 

type ListAlgorithmsRequest struct {
	*tchttp.BaseRequest
}

func NewListAlgorithmsRequest 

func NewListAlgorithmsRequest() (request *ListAlgorithmsRequest)

func (*ListAlgorithmsRequest) FromJsonString 

func (r *ListAlgorithmsRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ListAlgorithmsRequest) ToJsonString 

func (r *ListAlgorithmsRequest) ToJsonString() string

type ListAlgorithmsRequestParams 

type ListAlgorithmsRequestParams struct {
}

Predefined struct for user

type ListAlgorithmsResponse 

type ListAlgorithmsResponse struct {
	*tchttp.BaseResponse
	Response *ListAlgorithmsResponseParams `json:"Response"`
}

func NewListAlgorithmsResponse 

func NewListAlgorithmsResponse() (response *ListAlgorithmsResponse)

func (*ListAlgorithmsResponse) FromJsonString 

func (r *ListAlgorithmsResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ListAlgorithmsResponse) ToJsonString 

func (r *ListAlgorithmsResponse) ToJsonString() string

type ListAlgorithmsResponseParams 

type ListAlgorithmsResponseParams struct {
	// Symmetric encryption algorithms supported in this region
	SymmetricAlgorithms []*AlgorithmInfo `json:"SymmetricAlgorithms,omitnil,omitempty" name:"SymmetricAlgorithms"`

	// Asymmetric encryption algorithms supported in this region
	AsymmetricAlgorithms []*AlgorithmInfo `json:"AsymmetricAlgorithms,omitnil,omitempty" name:"AsymmetricAlgorithms"`

	// Asymmetric signature verification algorithms supported in the current region
	AsymmetricSignVerifyAlgorithms []*AlgorithmInfo `json:"AsymmetricSignVerifyAlgorithms,omitnil,omitempty" name:"AsymmetricSignVerifyAlgorithms"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ListKeyDetailRequest 

type ListKeyDetailRequest struct {
	*tchttp.BaseRequest

	// This parameter has the same meaning of the `Offset` in an SQL query, indicating that this acquisition starts from the "No. Offset value" element of the array arranged in a certain order. The default value is 0.
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// This parameter has the same meaning of the `Limit` in an SQL query, indicating that up to `Limit` value elements can be obtained in this request. The default value is 10 and the maximum value is 200.
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// Filters by creator role. 0 (default value): the CMK is created by the user; 1: the CMK is created automatically by an authorized Tencent Cloud service.
	Role *uint64 `json:"Role,omitnil,omitempty" name:"Role"`

	// Sorts by CMK creation time. 0: descending; 1: ascending
	OrderType *uint64 `json:"OrderType,omitnil,omitempty" name:"OrderType"`

	// Filters by CMK status. 0: all CMKs; 1: CMKs in `Enabled` status only; 2: CMKs in `Disabled` status only; 3: CMKs in `PendingDelete` status only (i.e., keys with schedule deletion enabled); 4: CMKs in `PendingImport` status only; 5: CMKs in `Archived` status only.
	KeyState *uint64 `json:"KeyState,omitnil,omitempty" name:"KeyState"`

	// Performs a fuzzy query by `KeyId` or `Alias`
	SearchKeyAlias *string `json:"SearchKeyAlias,omitnil,omitempty" name:"SearchKeyAlias"`

	// Filters by CMK type. "TENCENT_KMS" indicates to filter CMKs whose key materials are created by KMS; "EXTERNAL" indicates to filter CMKs of `EXTERNAL` type whose key materials are imported by users; "ALL" or empty indicates to filter CMKs of both types. This value is case-sensitive.
	Origin *string `json:"Origin,omitnil,omitempty" name:"Origin"`

	// Filters by the `KeyUsage` field value. Valid values: `ALL` (all CMKs), `ENCRYPT_DECRYPT` (used when this field is left empty), `ASYMMETRIC_DECRYPT_RSA_2048`, `ASYMMETRIC_DECRYPT_SM2`, `ASYMMETRIC_SIGN_VERIFY_SM2`, `ASYMMETRIC_SIGN_VERIFY_RSA_2048`, and `ASYMMETRIC_SIGN_VERIFY_ECC`.
	KeyUsage *string `json:"KeyUsage,omitnil,omitempty" name:"KeyUsage"`

	// Tag filter condition
	TagFilters []*TagFilter `json:"TagFilters,omitnil,omitempty" name:"TagFilters"`

	// ID of the HSM cluster. This field is only valid for Exclusive and Managed KMS instances.
	HsmClusterId *string `json:"HsmClusterId,omitnil,omitempty" name:"HsmClusterId"`
}

func NewListKeyDetailRequest 

func NewListKeyDetailRequest() (request *ListKeyDetailRequest)

func (*ListKeyDetailRequest) FromJsonString 

func (r *ListKeyDetailRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ListKeyDetailRequest) ToJsonString 

func (r *ListKeyDetailRequest) ToJsonString() string

type ListKeyDetailRequestParams 

type ListKeyDetailRequestParams struct {
	// This parameter has the same meaning of the `Offset` in an SQL query, indicating that this acquisition starts from the "No. Offset value" element of the array arranged in a certain order. The default value is 0.
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// This parameter has the same meaning of the `Limit` in an SQL query, indicating that up to `Limit` value elements can be obtained in this request. The default value is 10 and the maximum value is 200.
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// Filters by creator role. 0 (default value): the CMK is created by the user; 1: the CMK is created automatically by an authorized Tencent Cloud service.
	Role *uint64 `json:"Role,omitnil,omitempty" name:"Role"`

	// Sorts by CMK creation time. 0: descending; 1: ascending
	OrderType *uint64 `json:"OrderType,omitnil,omitempty" name:"OrderType"`

	// Filters by CMK status. 0: all CMKs; 1: CMKs in `Enabled` status only; 2: CMKs in `Disabled` status only; 3: CMKs in `PendingDelete` status only (i.e., keys with schedule deletion enabled); 4: CMKs in `PendingImport` status only; 5: CMKs in `Archived` status only.
	KeyState *uint64 `json:"KeyState,omitnil,omitempty" name:"KeyState"`

	// Performs a fuzzy query by `KeyId` or `Alias`
	SearchKeyAlias *string `json:"SearchKeyAlias,omitnil,omitempty" name:"SearchKeyAlias"`

	// Filters by CMK type. "TENCENT_KMS" indicates to filter CMKs whose key materials are created by KMS; "EXTERNAL" indicates to filter CMKs of `EXTERNAL` type whose key materials are imported by users; "ALL" or empty indicates to filter CMKs of both types. This value is case-sensitive.
	Origin *string `json:"Origin,omitnil,omitempty" name:"Origin"`

	// Filters by the `KeyUsage` field value. Valid values: `ALL` (all CMKs), `ENCRYPT_DECRYPT` (used when this field is left empty), `ASYMMETRIC_DECRYPT_RSA_2048`, `ASYMMETRIC_DECRYPT_SM2`, `ASYMMETRIC_SIGN_VERIFY_SM2`, `ASYMMETRIC_SIGN_VERIFY_RSA_2048`, and `ASYMMETRIC_SIGN_VERIFY_ECC`.
	KeyUsage *string `json:"KeyUsage,omitnil,omitempty" name:"KeyUsage"`

	// Tag filter condition
	TagFilters []*TagFilter `json:"TagFilters,omitnil,omitempty" name:"TagFilters"`

	// ID of the HSM cluster. This field is only valid for Exclusive and Managed KMS instances.
	HsmClusterId *string `json:"HsmClusterId,omitnil,omitempty" name:"HsmClusterId"`
}

Predefined struct for user

type ListKeyDetailResponse 

type ListKeyDetailResponse struct {
	*tchttp.BaseResponse
	Response *ListKeyDetailResponseParams `json:"Response"`
}

func NewListKeyDetailResponse 

func NewListKeyDetailResponse() (response *ListKeyDetailResponse)

func (*ListKeyDetailResponse) FromJsonString 

func (r *ListKeyDetailResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ListKeyDetailResponse) ToJsonString 

func (r *ListKeyDetailResponse) ToJsonString() string

type ListKeyDetailResponseParams 

type ListKeyDetailResponseParams struct {
	// Total number of CMKs
	TotalCount *uint64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// List of returned attribute information.
	// Note: this field may return null, indicating that no valid values can be obtained.
	KeyMetadatas []*KeyMetadata `json:"KeyMetadatas,omitnil,omitempty" name:"KeyMetadatas"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ListKeysRequest 

type ListKeysRequest struct {
	*tchttp.BaseRequest

	// This parameter has the same meaning of the `Offset` in an SQL query, indicating that this acquisition starts from the "No. Offset value" element of the array arranged in a certain order. The default value is 0
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// This parameter has the same meaning of the `Limit` in an SQL query, indicating that up to `Limit` value elements can be obtained in this request. The default value is 10 and the maximum value is 200
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// Filter by creator role. 0 (default value): the CMK is created by the user; 1: the CMK is created automatically by an authorized Tencent Cloud service
	Role *uint64 `json:"Role,omitnil,omitempty" name:"Role"`

	// ID of the HSM cluster. This field is only valid for Exclusive and Managed KMS instances.
	HsmClusterId *string `json:"HsmClusterId,omitnil,omitempty" name:"HsmClusterId"`
}

func NewListKeysRequest 

func NewListKeysRequest() (request *ListKeysRequest)

func (*ListKeysRequest) FromJsonString 

func (r *ListKeysRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ListKeysRequest) ToJsonString 

func (r *ListKeysRequest) ToJsonString() string

type ListKeysRequestParams 

type ListKeysRequestParams struct {
	// This parameter has the same meaning of the `Offset` in an SQL query, indicating that this acquisition starts from the "No. Offset value" element of the array arranged in a certain order. The default value is 0
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// This parameter has the same meaning of the `Limit` in an SQL query, indicating that up to `Limit` value elements can be obtained in this request. The default value is 10 and the maximum value is 200
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// Filter by creator role. 0 (default value): the CMK is created by the user; 1: the CMK is created automatically by an authorized Tencent Cloud service
	Role *uint64 `json:"Role,omitnil,omitempty" name:"Role"`

	// ID of the HSM cluster. This field is only valid for Exclusive and Managed KMS instances.
	HsmClusterId *string `json:"HsmClusterId,omitnil,omitempty" name:"HsmClusterId"`
}

Predefined struct for user

type ListKeysResponse 

type ListKeysResponse struct {
	*tchttp.BaseResponse
	Response *ListKeysResponseParams `json:"Response"`
}

func NewListKeysResponse 

func NewListKeysResponse() (response *ListKeysResponse)

func (*ListKeysResponse) FromJsonString 

func (r *ListKeysResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ListKeysResponse) ToJsonString 

func (r *ListKeysResponse) ToJsonString() string

type ListKeysResponseParams 

type ListKeysResponseParams struct {
	// CMK list array
	Keys []*Key `json:"Keys,omitnil,omitempty" name:"Keys"`

	// Total number of CMKs
	TotalCount *uint64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type OverwriteWhiteBoxDeviceFingerprintsRequest 

type OverwriteWhiteBoxDeviceFingerprintsRequest struct {
	*tchttp.BaseRequest

	// White-box key ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// Device fingerprint list. If the list is empty, it means to delete all fingerprint information corresponding to the key. There can be up to 200 entries in the list.
	DeviceFingerprints []*DeviceFingerprint `json:"DeviceFingerprints,omitnil,omitempty" name:"DeviceFingerprints"`
}

func NewOverwriteWhiteBoxDeviceFingerprintsRequest 

func NewOverwriteWhiteBoxDeviceFingerprintsRequest() (request *OverwriteWhiteBoxDeviceFingerprintsRequest)

func (*OverwriteWhiteBoxDeviceFingerprintsRequest) FromJsonString 

func (r *OverwriteWhiteBoxDeviceFingerprintsRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*OverwriteWhiteBoxDeviceFingerprintsRequest) ToJsonString 

func (r *OverwriteWhiteBoxDeviceFingerprintsRequest) ToJsonString() string

type OverwriteWhiteBoxDeviceFingerprintsRequestParams 

type OverwriteWhiteBoxDeviceFingerprintsRequestParams struct {
	// White-box key ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// Device fingerprint list. If the list is empty, it means to delete all fingerprint information corresponding to the key. There can be up to 200 entries in the list.
	DeviceFingerprints []*DeviceFingerprint `json:"DeviceFingerprints,omitnil,omitempty" name:"DeviceFingerprints"`
}

Predefined struct for user

type OverwriteWhiteBoxDeviceFingerprintsResponse 

type OverwriteWhiteBoxDeviceFingerprintsResponse struct {
	*tchttp.BaseResponse
	Response *OverwriteWhiteBoxDeviceFingerprintsResponseParams `json:"Response"`
}

func NewOverwriteWhiteBoxDeviceFingerprintsResponse 

func NewOverwriteWhiteBoxDeviceFingerprintsResponse() (response *OverwriteWhiteBoxDeviceFingerprintsResponse)

func (*OverwriteWhiteBoxDeviceFingerprintsResponse) FromJsonString 

func (r *OverwriteWhiteBoxDeviceFingerprintsResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*OverwriteWhiteBoxDeviceFingerprintsResponse) ToJsonString 

func (r *OverwriteWhiteBoxDeviceFingerprintsResponse) ToJsonString() string

type OverwriteWhiteBoxDeviceFingerprintsResponseParams 

type OverwriteWhiteBoxDeviceFingerprintsResponseParams struct {
	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type PostQuantumCryptoDecryptRequest 

type PostQuantumCryptoDecryptRequest struct {
	*tchttp.BaseRequest

	// The ciphertext data to be decrypted.
	CiphertextBlob *string `json:"CiphertextBlob,omitnil,omitempty" name:"CiphertextBlob"`

	// PEM-encoded public key (2048-bit RSA/SM2 key), which can be used to encrypt the `Plaintext` returned. If this field is left empty, the `Plaintext` will not be encrypted.
	EncryptionPublicKey *string `json:"EncryptionPublicKey,omitnil,omitempty" name:"EncryptionPublicKey"`

	// Asymmetric encryption algorithm. It is used in combination with `EncryptionPublicKey` to encrypt the returned data. u200dValues: `SM2` u200d(Return the ciphertext in the format of "C1C3C2"), `SM2_C1C3C2_ASN1` (Return the ciphertext in the format of "C1C3C2 ASN1"), `RSAES_PKCS1_V1_5`, `RSAES_OAEP_SHA_1`, `RSAES_OAEP_SHA_256`. It defaults to `SM2` if it's not specified.
	EncryptionAlgorithm *string `json:"EncryptionAlgorithm,omitnil,omitempty" name:"EncryptionAlgorithm"`
}

func NewPostQuantumCryptoDecryptRequest 

func NewPostQuantumCryptoDecryptRequest() (request *PostQuantumCryptoDecryptRequest)

func (*PostQuantumCryptoDecryptRequest) FromJsonString 

func (r *PostQuantumCryptoDecryptRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*PostQuantumCryptoDecryptRequest) ToJsonString 

func (r *PostQuantumCryptoDecryptRequest) ToJsonString() string

type PostQuantumCryptoDecryptRequestParams 

type PostQuantumCryptoDecryptRequestParams struct {
	// The ciphertext data to be decrypted.
	CiphertextBlob *string `json:"CiphertextBlob,omitnil,omitempty" name:"CiphertextBlob"`

	// PEM-encoded public key (2048-bit RSA/SM2 key), which can be used to encrypt the `Plaintext` returned. If this field is left empty, the `Plaintext` will not be encrypted.
	EncryptionPublicKey *string `json:"EncryptionPublicKey,omitnil,omitempty" name:"EncryptionPublicKey"`

	// Asymmetric encryption algorithm. It is used in combination with `EncryptionPublicKey` to encrypt the returned data. u200dValues: `SM2` u200d(Return the ciphertext in the format of "C1C3C2"), `SM2_C1C3C2_ASN1` (Return the ciphertext in the format of "C1C3C2 ASN1"), `RSAES_PKCS1_V1_5`, `RSAES_OAEP_SHA_1`, `RSAES_OAEP_SHA_256`. It defaults to `SM2` if it's not specified.
	EncryptionAlgorithm *string `json:"EncryptionAlgorithm,omitnil,omitempty" name:"EncryptionAlgorithm"`
}

Predefined struct for user

type PostQuantumCryptoDecryptResponse 

type PostQuantumCryptoDecryptResponse struct {
	*tchttp.BaseResponse
	Response *PostQuantumCryptoDecryptResponseParams `json:"Response"`
}

func NewPostQuantumCryptoDecryptResponse 

func NewPostQuantumCryptoDecryptResponse() (response *PostQuantumCryptoDecryptResponse)

func (*PostQuantumCryptoDecryptResponse) FromJsonString 

func (r *PostQuantumCryptoDecryptResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*PostQuantumCryptoDecryptResponse) ToJsonString 

func (r *PostQuantumCryptoDecryptResponse) ToJsonString() string

type PostQuantumCryptoDecryptResponseParams 

type PostQuantumCryptoDecryptResponseParams struct {
	// Globally unique CMK ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// If `EncryptionPublicKey` is left empty, a Base64-encoded ciphertext will be returned. To get the plaintext, you need to decode the ciphertext first.
	// If `EncryptionPublicKey` is passed in, this field u200dcontains the Base64-encoded ciphertext after asymmetric encryption by using the public key in `EncryptionPublicKey` To get the plaintext, you need to first decode the Base64 format, and then decrypwith the private key corresponding with the public key. The private key is uploaded by the user.
	PlainText *string `json:"PlainText,omitnil,omitempty" name:"PlainText"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type PostQuantumCryptoEncryptRequest 

type PostQuantumCryptoEncryptRequest struct {
	*tchttp.BaseRequest

	// Globally unique ID of the CMK generated by calling the `CreateKey` API
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// Encrypted plaintext data. This field must be Base64-encoded. The maximum size of the original data is 4 KB.
	PlainText *string `json:"PlainText,omitnil,omitempty" name:"PlainText"`
}

func NewPostQuantumCryptoEncryptRequest 

func NewPostQuantumCryptoEncryptRequest() (request *PostQuantumCryptoEncryptRequest)

func (*PostQuantumCryptoEncryptRequest) FromJsonString 

func (r *PostQuantumCryptoEncryptRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*PostQuantumCryptoEncryptRequest) ToJsonString 

func (r *PostQuantumCryptoEncryptRequest) ToJsonString() string

type PostQuantumCryptoEncryptRequestParams 

type PostQuantumCryptoEncryptRequestParams struct {
	// Globally unique ID of the CMK generated by calling the `CreateKey` API
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// Encrypted plaintext data. This field must be Base64-encoded. The maximum size of the original data is 4 KB.
	PlainText *string `json:"PlainText,omitnil,omitempty" name:"PlainText"`
}

Predefined struct for user

type PostQuantumCryptoEncryptResponse 

type PostQuantumCryptoEncryptResponse struct {
	*tchttp.BaseResponse
	Response *PostQuantumCryptoEncryptResponseParams `json:"Response"`
}

func NewPostQuantumCryptoEncryptResponse 

func NewPostQuantumCryptoEncryptResponse() (response *PostQuantumCryptoEncryptResponse)

func (*PostQuantumCryptoEncryptResponse) FromJsonString 

func (r *PostQuantumCryptoEncryptResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*PostQuantumCryptoEncryptResponse) ToJsonString 

func (r *PostQuantumCryptoEncryptResponse) ToJsonString() string

type PostQuantumCryptoEncryptResponseParams 

type PostQuantumCryptoEncryptResponseParams struct {
	// Base64-encoded ciphertext after encryption. This field contains the information of ciphertext and keys. It is not the result of encrypting the plaintext. To get the plaintext, you need to pass in this field to the PostQuantumCryptoDecrypt API.
	CiphertextBlob *string `json:"CiphertextBlob,omitnil,omitempty" name:"CiphertextBlob"`

	// Globally unique ID of the CMK used for encryption
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type PostQuantumCryptoSignRequest 

type PostQuantumCryptoSignRequest struct {
	*tchttp.BaseRequest

	// Original message text before Base64 encoding. It cannot exceed 4096 bytes.
	Message *string `json:"Message,omitnil,omitempty" name:"Message"`

	// Unique ID of a key
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

func NewPostQuantumCryptoSignRequest 

func NewPostQuantumCryptoSignRequest() (request *PostQuantumCryptoSignRequest)

func (*PostQuantumCryptoSignRequest) FromJsonString 

func (r *PostQuantumCryptoSignRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*PostQuantumCryptoSignRequest) ToJsonString 

func (r *PostQuantumCryptoSignRequest) ToJsonString() string

type PostQuantumCryptoSignRequestParams 

type PostQuantumCryptoSignRequestParams struct {
	// Original message text before Base64 encoding. It cannot exceed 4096 bytes.
	Message *string `json:"Message,omitnil,omitempty" name:"Message"`

	// Unique ID of a key
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

Predefined struct for user

type PostQuantumCryptoSignResponse 

type PostQuantumCryptoSignResponse struct {
	*tchttp.BaseResponse
	Response *PostQuantumCryptoSignResponseParams `json:"Response"`
}

func NewPostQuantumCryptoSignResponse 

func NewPostQuantumCryptoSignResponse() (response *PostQuantumCryptoSignResponse)

func (*PostQuantumCryptoSignResponse) FromJsonString 

func (r *PostQuantumCryptoSignResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*PostQuantumCryptoSignResponse) ToJsonString 

func (r *PostQuantumCryptoSignResponse) ToJsonString() string

type PostQuantumCryptoSignResponseParams 

type PostQuantumCryptoSignResponseParams struct {
	// Base64-encoded signature You can use PostQuantumCryptoVerify to verify the signature value.
	Signature *string `json:"Signature,omitnil,omitempty" name:"Signature"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type PostQuantumCryptoVerifyRequest 

type PostQuantumCryptoVerifyRequest struct {
	*tchttp.BaseRequest

	// Unique ID of a key
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// Signature value, which is generated by calling the `PostQuantumCryptoSign` API.
	SignatureValue *string `json:"SignatureValue,omitnil,omitempty" name:"SignatureValue"`

	// Original message text before Base64 encoding. It cannot exceed 4096 bytes.
	Message *string `json:"Message,omitnil,omitempty" name:"Message"`
}

func NewPostQuantumCryptoVerifyRequest 

func NewPostQuantumCryptoVerifyRequest() (request *PostQuantumCryptoVerifyRequest)

func (*PostQuantumCryptoVerifyRequest) FromJsonString 

func (r *PostQuantumCryptoVerifyRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*PostQuantumCryptoVerifyRequest) ToJsonString 

func (r *PostQuantumCryptoVerifyRequest) ToJsonString() string

type PostQuantumCryptoVerifyRequestParams 

type PostQuantumCryptoVerifyRequestParams struct {
	// Unique ID of a key
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// Signature value, which is generated by calling the `PostQuantumCryptoSign` API.
	SignatureValue *string `json:"SignatureValue,omitnil,omitempty" name:"SignatureValue"`

	// Original message text before Base64 encoding. It cannot exceed 4096 bytes.
	Message *string `json:"Message,omitnil,omitempty" name:"Message"`
}

Predefined struct for user

type PostQuantumCryptoVerifyResponse 

type PostQuantumCryptoVerifyResponse struct {
	*tchttp.BaseResponse
	Response *PostQuantumCryptoVerifyResponseParams `json:"Response"`
}

func NewPostQuantumCryptoVerifyResponse 

func NewPostQuantumCryptoVerifyResponse() (response *PostQuantumCryptoVerifyResponse)

func (*PostQuantumCryptoVerifyResponse) FromJsonString 

func (r *PostQuantumCryptoVerifyResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*PostQuantumCryptoVerifyResponse) ToJsonString 

func (r *PostQuantumCryptoVerifyResponse) ToJsonString() string

type PostQuantumCryptoVerifyResponseParams 

type PostQuantumCryptoVerifyResponseParams struct {
	// Verify whether the signature is valid. `true`: The signature is valid. `false`: The signature is invalid.
	SignatureValid *bool `json:"SignatureValid,omitnil,omitempty" name:"SignatureValid"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ReEncryptRequest 

type ReEncryptRequest struct {
	*tchttp.BaseRequest

	// Ciphertext to be re-encrypted
	CiphertextBlob *string `json:"CiphertextBlob,omitnil,omitempty" name:"CiphertextBlob"`

	// CMK used for re-encryption. If this parameter is empty, the ciphertext will be re-encrypted by using the original CMK (as long as the key is not rotated, the ciphertext will not be refreshed)
	DestinationKeyId *string `json:"DestinationKeyId,omitnil,omitempty" name:"DestinationKeyId"`

	// JSON string of the key-value pair used during ciphertext encryption by `CiphertextBlob`. If not used during encryption, this parameter will be empty
	SourceEncryptionContext *string `json:"SourceEncryptionContext,omitnil,omitempty" name:"SourceEncryptionContext"`

	// JSON string of the key-value pair used during re-encryption. If this field is used, the same string should be entered when the returned new ciphertext is decrypted
	DestinationEncryptionContext *string `json:"DestinationEncryptionContext,omitnil,omitempty" name:"DestinationEncryptionContext"`
}

func NewReEncryptRequest 

func NewReEncryptRequest() (request *ReEncryptRequest)

func (*ReEncryptRequest) FromJsonString 

func (r *ReEncryptRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ReEncryptRequest) ToJsonString 

func (r *ReEncryptRequest) ToJsonString() string

type ReEncryptRequestParams 

type ReEncryptRequestParams struct {
	// Ciphertext to be re-encrypted
	CiphertextBlob *string `json:"CiphertextBlob,omitnil,omitempty" name:"CiphertextBlob"`

	// CMK used for re-encryption. If this parameter is empty, the ciphertext will be re-encrypted by using the original CMK (as long as the key is not rotated, the ciphertext will not be refreshed)
	DestinationKeyId *string `json:"DestinationKeyId,omitnil,omitempty" name:"DestinationKeyId"`

	// JSON string of the key-value pair used during ciphertext encryption by `CiphertextBlob`. If not used during encryption, this parameter will be empty
	SourceEncryptionContext *string `json:"SourceEncryptionContext,omitnil,omitempty" name:"SourceEncryptionContext"`

	// JSON string of the key-value pair used during re-encryption. If this field is used, the same string should be entered when the returned new ciphertext is decrypted
	DestinationEncryptionContext *string `json:"DestinationEncryptionContext,omitnil,omitempty" name:"DestinationEncryptionContext"`
}

Predefined struct for user

type ReEncryptResponse 

type ReEncryptResponse struct {
	*tchttp.BaseResponse
	Response *ReEncryptResponseParams `json:"Response"`
}

func NewReEncryptResponse 

func NewReEncryptResponse() (response *ReEncryptResponse)

func (*ReEncryptResponse) FromJsonString 

func (r *ReEncryptResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ReEncryptResponse) ToJsonString 

func (r *ReEncryptResponse) ToJsonString() string

type ReEncryptResponseParams 

type ReEncryptResponseParams struct {
	// Re-encrypted ciphertext
	CiphertextBlob *string `json:"CiphertextBlob,omitnil,omitempty" name:"CiphertextBlob"`

	// CMK used for re-encryption
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// CMK used by ciphertext before re-encryption
	SourceKeyId *string `json:"SourceKeyId,omitnil,omitempty" name:"SourceKeyId"`

	// `true` indicates that the ciphertext has been re-encrypted. When re-encryption is initiated by using the same CMK, as long as the CMK is not rotated, no actual re-encryption will be performed, and the original ciphertext will be returned
	ReEncrypted *bool `json:"ReEncrypted,omitnil,omitempty" name:"ReEncrypted"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ScheduleKeyDeletionRequest 

type ScheduleKeyDeletionRequest struct {
	*tchttp.BaseRequest

	// Unique CMK ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// Schedule deletion time range. Value range: [7,30]
	PendingWindowInDays *uint64 `json:"PendingWindowInDays,omitnil,omitempty" name:"PendingWindowInDays"`
}

func NewScheduleKeyDeletionRequest 

func NewScheduleKeyDeletionRequest() (request *ScheduleKeyDeletionRequest)

func (*ScheduleKeyDeletionRequest) FromJsonString 

func (r *ScheduleKeyDeletionRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ScheduleKeyDeletionRequest) ToJsonString 

func (r *ScheduleKeyDeletionRequest) ToJsonString() string

type ScheduleKeyDeletionRequestParams 

type ScheduleKeyDeletionRequestParams struct {
	// Unique CMK ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// Schedule deletion time range. Value range: [7,30]
	PendingWindowInDays *uint64 `json:"PendingWindowInDays,omitnil,omitempty" name:"PendingWindowInDays"`
}

Predefined struct for user

type ScheduleKeyDeletionResponse 

type ScheduleKeyDeletionResponse struct {
	*tchttp.BaseResponse
	Response *ScheduleKeyDeletionResponseParams `json:"Response"`
}

func NewScheduleKeyDeletionResponse 

func NewScheduleKeyDeletionResponse() (response *ScheduleKeyDeletionResponse)

func (*ScheduleKeyDeletionResponse) FromJsonString 

func (r *ScheduleKeyDeletionResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ScheduleKeyDeletionResponse) ToJsonString 

func (r *ScheduleKeyDeletionResponse) ToJsonString() string

type ScheduleKeyDeletionResponseParams 

type ScheduleKeyDeletionResponseParams struct {
	// Schedule deletion execution time
	DeletionDate *uint64 `json:"DeletionDate,omitnil,omitempty" name:"DeletionDate"`

	// Unique ID of the CMK scheduled for deletion
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type SignByAsymmetricKeyRequest 

type SignByAsymmetricKeyRequest struct {
	*tchttp.BaseRequest

	// Signature algorithm. The valid values include `SM2DSA`, `ECC_P256_R1`, `RSA_PSS_SHA_256`, and `RSA_PKCS1_SHA_256`, etc. You can get a full list of supported algorithms using the ListAlgorithms API.
	Algorithm *string `json:"Algorithm,omitnil,omitempty" name:"Algorithm"`

	// Full message or message abstract. Before Base64 encoding, an original message can contain up to 4,096 bytes while a message abstract must be 32 bytes.
	Message *string `json:"Message,omitnil,omitempty" name:"Message"`

	// Unique ID of a key
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// Message type. Valid values: `RAW` (indicating an original message; used by default if the parameter is not passed in) and `DIGEST`.
	MessageType *string `json:"MessageType,omitnil,omitempty" name:"MessageType"`
}

func NewSignByAsymmetricKeyRequest 

func NewSignByAsymmetricKeyRequest() (request *SignByAsymmetricKeyRequest)

func (*SignByAsymmetricKeyRequest) FromJsonString 

func (r *SignByAsymmetricKeyRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*SignByAsymmetricKeyRequest) ToJsonString 

func (r *SignByAsymmetricKeyRequest) ToJsonString() string

type SignByAsymmetricKeyRequestParams 

type SignByAsymmetricKeyRequestParams struct {
	// Signature algorithm. The valid values include `SM2DSA`, `ECC_P256_R1`, `RSA_PSS_SHA_256`, and `RSA_PKCS1_SHA_256`, etc. You can get a full list of supported algorithms using the ListAlgorithms API.
	Algorithm *string `json:"Algorithm,omitnil,omitempty" name:"Algorithm"`

	// Full message or message abstract. Before Base64 encoding, an original message can contain up to 4,096 bytes while a message abstract must be 32 bytes.
	Message *string `json:"Message,omitnil,omitempty" name:"Message"`

	// Unique ID of a key
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// Message type. Valid values: `RAW` (indicating an original message; used by default if the parameter is not passed in) and `DIGEST`.
	MessageType *string `json:"MessageType,omitnil,omitempty" name:"MessageType"`
}

Predefined struct for user

type SignByAsymmetricKeyResponse 

type SignByAsymmetricKeyResponse struct {
	*tchttp.BaseResponse
	Response *SignByAsymmetricKeyResponseParams `json:"Response"`
}

func NewSignByAsymmetricKeyResponse 

func NewSignByAsymmetricKeyResponse() (response *SignByAsymmetricKeyResponse)

func (*SignByAsymmetricKeyResponse) FromJsonString 

func (r *SignByAsymmetricKeyResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*SignByAsymmetricKeyResponse) ToJsonString 

func (r *SignByAsymmetricKeyResponse) ToJsonString() string

type SignByAsymmetricKeyResponseParams 

type SignByAsymmetricKeyResponseParams struct {
	// Base64-encoded signature
	Signature *string `json:"Signature,omitnil,omitempty" name:"Signature"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type Tag 

type Tag struct {
	// Tag key
	TagKey *string `json:"TagKey,omitnil,omitempty" name:"TagKey"`

	// Tag value
	TagValue *string `json:"TagValue,omitnil,omitempty" name:"TagValue"`
}

type TagFilter 

type TagFilter struct {
	// Tag key
	TagKey *string `json:"TagKey,omitnil,omitempty" name:"TagKey"`

	// Tag value
	TagValue []*string `json:"TagValue,omitnil,omitempty" name:"TagValue"`
}

type UnbindCloudResourceRequest 

type UnbindCloudResourceRequest struct {
	*tchttp.BaseRequest

	// CMK ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// Unique ID of a Tencent Cloud service
	ProductId *string `json:"ProductId,omitnil,omitempty" name:"ProductId"`

	// Resource/instance ID, which is stored as a string and defined by the caller based on the Tencent Cloud service’s features.
	ResourceId *string `json:"ResourceId,omitnil,omitempty" name:"ResourceId"`
}

func NewUnbindCloudResourceRequest 

func NewUnbindCloudResourceRequest() (request *UnbindCloudResourceRequest)

func (*UnbindCloudResourceRequest) FromJsonString 

func (r *UnbindCloudResourceRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*UnbindCloudResourceRequest) ToJsonString 

func (r *UnbindCloudResourceRequest) ToJsonString() string

type UnbindCloudResourceRequestParams 

type UnbindCloudResourceRequestParams struct {
	// CMK ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// Unique ID of a Tencent Cloud service
	ProductId *string `json:"ProductId,omitnil,omitempty" name:"ProductId"`

	// Resource/instance ID, which is stored as a string and defined by the caller based on the Tencent Cloud service’s features.
	ResourceId *string `json:"ResourceId,omitnil,omitempty" name:"ResourceId"`
}

Predefined struct for user

type UnbindCloudResourceResponse 

type UnbindCloudResourceResponse struct {
	*tchttp.BaseResponse
	Response *UnbindCloudResourceResponseParams `json:"Response"`
}

func NewUnbindCloudResourceResponse 

func NewUnbindCloudResourceResponse() (response *UnbindCloudResourceResponse)

func (*UnbindCloudResourceResponse) FromJsonString 

func (r *UnbindCloudResourceResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*UnbindCloudResourceResponse) ToJsonString 

func (r *UnbindCloudResourceResponse) ToJsonString() string

type UnbindCloudResourceResponseParams 

type UnbindCloudResourceResponseParams struct {
	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type UpdateAliasRequest 

type UpdateAliasRequest struct {
	*tchttp.BaseRequest

	// New alias containing 1-60 characters or digits
	Alias *string `json:"Alias,omitnil,omitempty" name:"Alias"`

	// Globally unique CMK ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

func NewUpdateAliasRequest 

func NewUpdateAliasRequest() (request *UpdateAliasRequest)

func (*UpdateAliasRequest) FromJsonString 

func (r *UpdateAliasRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*UpdateAliasRequest) ToJsonString 

func (r *UpdateAliasRequest) ToJsonString() string

type UpdateAliasRequestParams 

type UpdateAliasRequestParams struct {
	// New alias containing 1-60 characters or digits
	Alias *string `json:"Alias,omitnil,omitempty" name:"Alias"`

	// Globally unique CMK ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

Predefined struct for user

type UpdateAliasResponse 

type UpdateAliasResponse struct {
	*tchttp.BaseResponse
	Response *UpdateAliasResponseParams `json:"Response"`
}

func NewUpdateAliasResponse 

func NewUpdateAliasResponse() (response *UpdateAliasResponse)

func (*UpdateAliasResponse) FromJsonString 

func (r *UpdateAliasResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*UpdateAliasResponse) ToJsonString 

func (r *UpdateAliasResponse) ToJsonString() string

type UpdateAliasResponseParams 

type UpdateAliasResponseParams struct {
	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type UpdateKeyDescriptionRequest 

type UpdateKeyDescriptionRequest struct {
	*tchttp.BaseRequest

	// New description of up to 1,024 bytes in length
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// ID of the CMK for which to modify the description
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

func NewUpdateKeyDescriptionRequest 

func NewUpdateKeyDescriptionRequest() (request *UpdateKeyDescriptionRequest)

func (*UpdateKeyDescriptionRequest) FromJsonString 

func (r *UpdateKeyDescriptionRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*UpdateKeyDescriptionRequest) ToJsonString 

func (r *UpdateKeyDescriptionRequest) ToJsonString() string

type UpdateKeyDescriptionRequestParams 

type UpdateKeyDescriptionRequestParams struct {
	// New description of up to 1,024 bytes in length
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// ID of the CMK for which to modify the description
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

Predefined struct for user

type UpdateKeyDescriptionResponse 

type UpdateKeyDescriptionResponse struct {
	*tchttp.BaseResponse
	Response *UpdateKeyDescriptionResponseParams `json:"Response"`
}

func NewUpdateKeyDescriptionResponse 

func NewUpdateKeyDescriptionResponse() (response *UpdateKeyDescriptionResponse)

func (*UpdateKeyDescriptionResponse) FromJsonString 

func (r *UpdateKeyDescriptionResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*UpdateKeyDescriptionResponse) ToJsonString 

func (r *UpdateKeyDescriptionResponse) ToJsonString() string

type UpdateKeyDescriptionResponseParams 

type UpdateKeyDescriptionResponseParams struct {
	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type VerifyByAsymmetricKeyRequest 

type VerifyByAsymmetricKeyRequest struct {
	*tchttp.BaseRequest

	// Unique ID of a key
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// Signature value, which is generated by calling the KMS signature API.
	SignatureValue *string `json:"SignatureValue,omitnil,omitempty" name:"SignatureValue"`

	// Full message or message abstract. Before Base64 encoding, an original message can contain up to 4,096 bytes while a message abstract must be 32 bytes.
	Message *string `json:"Message,omitnil,omitempty" name:"Message"`

	// Signature algorithm. The valid values include `SM2DSA`, `ECC_P256_R1`, `RSA_PSS_SHA_256`, and `RSA_PKCS1_SHA_256`, etc. You can get a full list of supported algorithms using the ListAlgorithms API.
	Algorithm *string `json:"Algorithm,omitnil,omitempty" name:"Algorithm"`

	// Message type. Valid values: `RAW` (indicating an original message; used by default if the parameter is not passed in) and `DIGEST`.
	MessageType *string `json:"MessageType,omitnil,omitempty" name:"MessageType"`
}

func NewVerifyByAsymmetricKeyRequest 

func NewVerifyByAsymmetricKeyRequest() (request *VerifyByAsymmetricKeyRequest)

func (*VerifyByAsymmetricKeyRequest) FromJsonString 

func (r *VerifyByAsymmetricKeyRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*VerifyByAsymmetricKeyRequest) ToJsonString 

func (r *VerifyByAsymmetricKeyRequest) ToJsonString() string

type VerifyByAsymmetricKeyRequestParams 

type VerifyByAsymmetricKeyRequestParams struct {
	// Unique ID of a key
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// Signature value, which is generated by calling the KMS signature API.
	SignatureValue *string `json:"SignatureValue,omitnil,omitempty" name:"SignatureValue"`

	// Full message or message abstract. Before Base64 encoding, an original message can contain up to 4,096 bytes while a message abstract must be 32 bytes.
	Message *string `json:"Message,omitnil,omitempty" name:"Message"`

	// Signature algorithm. The valid values include `SM2DSA`, `ECC_P256_R1`, `RSA_PSS_SHA_256`, and `RSA_PKCS1_SHA_256`, etc. You can get a full list of supported algorithms using the ListAlgorithms API.
	Algorithm *string `json:"Algorithm,omitnil,omitempty" name:"Algorithm"`

	// Message type. Valid values: `RAW` (indicating an original message; used by default if the parameter is not passed in) and `DIGEST`.
	MessageType *string `json:"MessageType,omitnil,omitempty" name:"MessageType"`
}

Predefined struct for user

type VerifyByAsymmetricKeyResponse 

type VerifyByAsymmetricKeyResponse struct {
	*tchttp.BaseResponse
	Response *VerifyByAsymmetricKeyResponseParams `json:"Response"`
}

func NewVerifyByAsymmetricKeyResponse 

func NewVerifyByAsymmetricKeyResponse() (response *VerifyByAsymmetricKeyResponse)

func (*VerifyByAsymmetricKeyResponse) FromJsonString 

func (r *VerifyByAsymmetricKeyResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*VerifyByAsymmetricKeyResponse) ToJsonString 

func (r *VerifyByAsymmetricKeyResponse) ToJsonString() string

type VerifyByAsymmetricKeyResponseParams 

type VerifyByAsymmetricKeyResponseParams struct {
	// Whether the signature is valid. `true`: the signature is valid; `false`: the signature is invalid.
	SignatureValid *bool `json:"SignatureValid,omitnil,omitempty" name:"SignatureValid"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type WhiteboxKeyInfo 

type WhiteboxKeyInfo struct {
	// Globally unique white-box key ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// Unique alias that makes a key more recognizable and understandable. This parameter cannot be empty, can contain 1 to 60 letters, digits, hyphens (-), and underscores (_), and must begin with a letter or digit.
	Alias *string `json:"Alias,omitnil,omitempty" name:"Alias"`

	// Creator
	CreatorUin *uint64 `json:"CreatorUin,omitnil,omitempty" name:"CreatorUin"`

	// Key description information
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// Key creation time in Unix timestamp
	CreateTime *uint64 `json:"CreateTime,omitnil,omitempty" name:"CreateTime"`

	// White-box key status. Valid values: Enabled, Disabled
	Status *string `json:"Status,omitnil,omitempty" name:"Status"`

	// Creator
	OwnerUin *uint64 `json:"OwnerUin,omitnil,omitempty" name:"OwnerUin"`

	// Key algorithm type
	Algorithm *string `json:"Algorithm,omitnil,omitempty" name:"Algorithm"`

	// Base64-encoded white-box encryption key
	EncryptKey *string `json:"EncryptKey,omitnil,omitempty" name:"EncryptKey"`

	// Base64-encoded white-box decryption key
	DecryptKey *string `json:"DecryptKey,omitnil,omitempty" name:"DecryptKey"`

	// Resource ID in the format of `creatorUin/$creatorUin/$keyId`
	ResourceId *string `json:"ResourceId,omitnil,omitempty" name:"ResourceId"`

	// Whether there is a device fingerprint bound to the current key
	// Note: this field may return null, indicating that no valid values can be obtained.
	DeviceFingerprintBind *bool `json:"DeviceFingerprintBind,omitnil,omitempty" name:"DeviceFingerprintBind"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.