Struct: kms.DecryptOutput

import "../ibm-cos-sdk-go/service/kms"

Implemented Interfaces

s3crypto.Cipher, s3manager.ReadSeekerWriteTo, s3manager.WriterReadFrom

Structure Field Summary

• EncryptionAlgorithm *string

  The encryption algorithm that was used to decrypt the ciphertext.

• KeyId *string

  The Amazon Resource Name (key ARN (docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN)) of the KMS key that was used to decrypt the ciphertext.

• Plaintext []byte

  Decrypted plaintext data.

• _ struct{}

Service Operations

• GoString() string operation

  GoString returns the string representation.

• SetEncryptionAlgorithm(string) *DecryptOutput operation

  SetEncryptionAlgorithm sets the EncryptionAlgorithm field's value.

• SetKeyId(string) *DecryptOutput operation

  SetKeyId sets the KeyId field's value.

• SetPlaintext([]byte) *DecryptOutput operation

  SetPlaintext sets the Plaintext field's value.

• String() string operation

  String returns the string representation.

Structure Field Details

EncryptionAlgorithm *string `type:"string" enum:"EncryptionAlgorithmSpec"`

The encryption algorithm that was used to decrypt the ciphertext.

KeyId *string `min:"1" type:"string"`

The Amazon Resource Name (key ARN (docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN)) of the KMS key that was used to decrypt the ciphertext.

Plaintext []byte `min:"1" type:"blob" sensitive:"true"`

Decrypted plaintext data. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

If the response includes the CiphertextForRecipient field, the Plaintext field is null or empty.

Plaintext is a sensitive parameter and its value will be replaced with “sensitive” in string returned by DecryptOutput's String and GoString methods.

Plaintext is automatically base64 encoded/decoded by the SDK.

_ struct{} `type:"structure"`

Method Details

func (s DecryptOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as “sensitive” in the API will not be included in the string output. The member name will be present, but the value will be replaced with “sensitive”.

// File 'service/kms/api.go', line 10115

func (s DecryptOutput) GoString() string {
	return s.String()
}

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

SetEncryptionAlgorithm sets the EncryptionAlgorithm field's value.

// File 'service/kms/api.go', line 10120

func (s *DecryptOutput) SetEncryptionAlgorithm(v string) *DecryptOutput {
	s.EncryptionAlgorithm = &v
	return s
}

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

SetKeyId sets the KeyId field's value.

// File 'service/kms/api.go', line 10126

func (s *DecryptOutput) SetKeyId(v string) *DecryptOutput {
	s.KeyId = &v
	return s
}

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

SetPlaintext sets the Plaintext field's value.

// File 'service/kms/api.go', line 10132

func (s *DecryptOutput) SetPlaintext(v []byte) *DecryptOutput {
	s.Plaintext = v
	return s
}

func (s DecryptOutput) String() string

String returns the string representation.

API parameter values that are decorated as “sensitive” in the API will not be included in the string output. The member name will be present, but the value will be replaced with “sensitive”.

// File 'service/kms/api.go', line 10106

func (s DecryptOutput) String() string {
	return awsutil.Prettify(s)
}