Skip to content
This repository was archived by the owner on Jul 31, 2025. It is now read-only.

Commit f5b95c8

Browse files
lucix-awslucix-aws
authored
Merge pull request #5044 from josephbartley/fix-deprecated-documentation
Fix deprecated function documentation
2 parents 0ace168 + 23ca94c commit f5b95c8

File tree

6 files changed

+19
-19
lines changed

6 files changed

+19
-19
lines changed

‎service/s3/s3crypto/aes_cbc_content_cipher.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ type cbcContentCipherBuilder struct {
1717
// AESCBCContentCipherBuilder returns a new encryption only AES/CBC mode structure using the provided padder. The provided cipher data generator
1818
// will be used to provide keys for content encryption.
1919
//
20-
// deprecated: This feature is in maintenance mode, no new updates will be released. Please see https://docs.aws.amazon.com/general/latest/gr/aws_sdk_cryptography.html for more information.
20+
// Deprecated: This feature is in maintenance mode, no new updates will be released. Please see https://docs.aws.amazon.com/general/latest/gr/aws_sdk_cryptography.html for more information.
2121
func AESCBCContentCipherBuilder(generator CipherDataGenerator, padder Padder) ContentCipherBuilder {
2222
return cbcContentCipherBuilder{generator: generator, padder: padder}
2323
}
@@ -31,7 +31,7 @@ func AESCBCContentCipherBuilder(generator CipherDataGenerator, padder Padder) Co
3131
// panic(err) // handle error
3232
// }
3333
//
34-
// deprecated: This feature is in maintenance mode, no new updates will be released. Please see https://docs.aws.amazon.com/general/latest/gr/aws_sdk_cryptography.html for more information.
34+
// Deprecated: This feature is in maintenance mode, no new updates will be released. Please see https://docs.aws.amazon.com/general/latest/gr/aws_sdk_cryptography.html for more information.
3535
func RegisterAESCBCContentCipher(registry *CryptoRegistry, padder Padder) error {
3636
if registry == nil {
3737
return errNilCryptoRegistry

‎service/s3/s3crypto/aes_gcm_content_cipher.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ const (
1919
// will be fully loaded into memory before encryption or decryption can occur. Caution must be taken to avoid memory
2020
// allocation failures.
2121
//
22-
// deprecated: This feature is in maintenance mode, no new updates will be released. Please see https://docs.aws.amazon.com/general/latest/gr/aws_sdk_cryptography.html for more information.
22+
// Deprecated: This feature is in maintenance mode, no new updates will be released. Please see https://docs.aws.amazon.com/general/latest/gr/aws_sdk_cryptography.html for more information.
2323
func AESGCMContentCipherBuilder(generator CipherDataGenerator) ContentCipherBuilder {
2424
return gcmContentCipherBuilder{generator}
2525
}

‎service/s3/s3crypto/decryption_client.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ type CEKEntry func(CipherData) (ContentCipher, error)
2525
// - AES/GCM
2626
// - AES/CBC
2727
//
28-
// deprecated: This feature is in maintenance mode, no new updates will be released. Please see https://docs.aws.amazon.com/general/latest/gr/aws_sdk_cryptography.html for more information.
28+
// Deprecated: This feature is in maintenance mode, no new updates will be released. Please see https://docs.aws.amazon.com/general/latest/gr/aws_sdk_cryptography.html for more information.
2929
type DecryptionClient struct {
3030
S3Client s3iface.S3API
3131
// LoadStrategy is used to load the metadata either from the metadata of the object
@@ -48,7 +48,7 @@ type DecryptionClient struct {
4848
// // Custom client options here
4949
// }))
5050
//
51-
// deprecated: This feature is in maintenance mode, no new updates will be released. Please see https://docs.aws.amazon.com/general/latest/gr/aws_sdk_cryptography.html for more information.
51+
// Deprecated: This feature is in maintenance mode, no new updates will be released. Please see https://docs.aws.amazon.com/general/latest/gr/aws_sdk_cryptography.html for more information.
5252
func NewDecryptionClient(prov client.ConfigProvider, options ...func(*DecryptionClient)) *DecryptionClient {
5353
s3client := s3.New(prov)
5454

@@ -95,14 +95,14 @@ func NewDecryptionClient(prov client.ConfigProvider, options ...func(*Decryption
9595
// })
9696
// err := req.Send()
9797
//
98-
// deprecated: This feature is in maintenance mode, no new updates will be released. Please see https://docs.aws.amazon.com/general/latest/gr/aws_sdk_cryptography.html for more information.
98+
// Deprecated: This feature is in maintenance mode, no new updates will be released. Please see https://docs.aws.amazon.com/general/latest/gr/aws_sdk_cryptography.html for more information.
9999
func (c *DecryptionClient) GetObjectRequest(input *s3.GetObjectInput) (*request.Request, *s3.GetObjectOutput) {
100100
return getObjectRequest(c.getClientOptions(), input)
101101
}
102102

103103
// GetObject is a wrapper for GetObjectRequest
104104
//
105-
// deprecated: This feature is in maintenance mode, no new updates will be released. Please see https://docs.aws.amazon.com/general/latest/gr/aws_sdk_cryptography.html for more information.
105+
// Deprecated: This feature is in maintenance mode, no new updates will be released. Please see https://docs.aws.amazon.com/general/latest/gr/aws_sdk_cryptography.html for more information.
106106
func (c *DecryptionClient) GetObject(input *s3.GetObjectInput) (*s3.GetObjectOutput, error) {
107107
return getObject(c.getClientOptions(), input)
108108
}
@@ -115,7 +115,7 @@ func (c *DecryptionClient) GetObject(input *s3.GetObjectInput) (*s3.GetObjectOut
115115
// cause a panic. Use the Context to add deadlining, timeouts, etc. In the future
116116
// this may create sub-contexts for individual underlying requests.
117117
//
118-
// deprecated: This feature is in maintenance mode, no new updates will be released. Please see https://docs.aws.amazon.com/general/latest/gr/aws_sdk_cryptography.html for more information.
118+
// Deprecated: This feature is in maintenance mode, no new updates will be released. Please see https://docs.aws.amazon.com/general/latest/gr/aws_sdk_cryptography.html for more information.
119119
func (c *DecryptionClient) GetObjectWithContext(ctx aws.Context, input *s3.GetObjectInput, opts ...request.Option) (*s3.GetObjectOutput, error) {
120120
return getObjectWithContext(c.getClientOptions(), ctx, input, opts...)
121121
}

‎service/s3/s3crypto/encryption_client.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ const DefaultMinFileSize = 1024 * 512 * 5
1818
// AES GCM will load all data into memory. However, the rest of the content algorithms
1919
// do not load the entire contents into memory.
2020
//
21-
// deprecated: This feature is in maintenance mode, no new updates will be released. Please see https://docs.aws.amazon.com/general/latest/gr/aws_sdk_cryptography.html for more information.
21+
// Deprecated: This feature is in maintenance mode, no new updates will be released. Please see https://docs.aws.amazon.com/general/latest/gr/aws_sdk_cryptography.html for more information.
2222
type EncryptionClient struct {
2323
S3Client s3iface.S3API
2424
ContentCipherBuilder ContentCipherBuilder
@@ -56,7 +56,7 @@ func validateV1EncryptionClientConstruction(c *EncryptionClient) error {
5656
// handler := s3crypto.NewKMSKeyGenerator(kms.New(sess), cmkID)
5757
// svc := s3crypto.NewEncryptionClient(sess, s3crypto.AESGCMContentCipherBuilder(handler))
5858
//
59-
// deprecated: This feature is in maintenance mode, no new updates will be released. Please see https://docs.aws.amazon.com/general/latest/gr/aws_sdk_cryptography.html for more information.
59+
// Deprecated: This feature is in maintenance mode, no new updates will be released. Please see https://docs.aws.amazon.com/general/latest/gr/aws_sdk_cryptography.html for more information.
6060
func NewEncryptionClient(prov client.ConfigProvider, builder ContentCipherBuilder, options ...func(*EncryptionClient)) *EncryptionClient {
6161
s3client := s3.New(prov)
6262

@@ -91,7 +91,7 @@ func NewEncryptionClient(prov client.ConfigProvider, builder ContentCipherBuilde
9191
// })
9292
// err := req.Send()
9393
//
94-
// deprecated: This feature is in maintenance mode, no new updates will be released. Please see https://docs.aws.amazon.com/general/latest/gr/aws_sdk_cryptography.html for more information.
94+
// Deprecated: This feature is in maintenance mode, no new updates will be released. Please see https://docs.aws.amazon.com/general/latest/gr/aws_sdk_cryptography.html for more information.
9595
func (c *EncryptionClient) PutObjectRequest(input *s3.PutObjectInput) (*request.Request, *s3.PutObjectOutput) {
9696
req, out := putObjectRequest(c.getClientOptions(), input)
9797
if err := validateV1EncryptionClientConstruction(c); err != nil {
@@ -114,7 +114,7 @@ func setReqError(err error) func(*request.Request) {
114114

115115
// PutObject is a wrapper for PutObjectRequest
116116
//
117-
// deprecated: This feature is in maintenance mode, no new updates will be released. Please see https://docs.aws.amazon.com/general/latest/gr/aws_sdk_cryptography.html for more information.
117+
// Deprecated: This feature is in maintenance mode, no new updates will be released. Please see https://docs.aws.amazon.com/general/latest/gr/aws_sdk_cryptography.html for more information.
118118
func (c *EncryptionClient) PutObject(input *s3.PutObjectInput) (*s3.PutObjectOutput, error) {
119119
if err := validateV1EncryptionClientConstruction(c); err != nil {
120120
return nil, err
@@ -131,7 +131,7 @@ func (c *EncryptionClient) PutObject(input *s3.PutObjectInput) (*s3.PutObjectOut
131131
// this may create sub-contexts for individual underlying requests.
132132
// PutObject is a wrapper for PutObjectRequest
133133
//
134-
// deprecated: This feature is in maintenance mode, no new updates will be released. Please see https://docs.aws.amazon.com/general/latest/gr/aws_sdk_cryptography.html for more information.
134+
// Deprecated: This feature is in maintenance mode, no new updates will be released. Please see https://docs.aws.amazon.com/general/latest/gr/aws_sdk_cryptography.html for more information.
135135
func (c *EncryptionClient) PutObjectWithContext(ctx aws.Context, input *s3.PutObjectInput, opts ...request.Option) (*s3.PutObjectOutput, error) {
136136
if err := validateV1EncryptionClientConstruction(c); err != nil {
137137
return nil, err

‎service/s3/s3crypto/envelope.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ type Envelope struct {
3939
CEKAlg string `json:"x-amz-cek-alg"`
4040
TagLen string `json:"x-amz-tag-len"`
4141

42-
// deprecated: This MD5 hash is no longer populated
42+
// Deprecated: This MD5 hash is no longer populated
4343
UnencryptedMD5 string `json:"-"`
4444

4545
UnencryptedContentLen string `json:"x-amz-unencrypted-content-length"`

‎service/s3/s3crypto/kms_key_handler.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ type kmsKeyHandler struct {
3333
// matdesc := s3crypto.MaterialDescription{}
3434
// handler := s3crypto.NewKMSKeyGenerator(kms.New(sess), cmkID)
3535
//
36-
// deprecated: This feature is in maintenance mode, no new updates will be released. Please see https://docs.aws.amazon.com/general/latest/gr/aws_sdk_cryptography.html for more information.
36+
// Deprecated: This feature is in maintenance mode, no new updates will be released. Please see https://docs.aws.amazon.com/general/latest/gr/aws_sdk_cryptography.html for more information.
3737
func NewKMSKeyGenerator(kmsClient kmsiface.KMSAPI, cmkID string) CipherDataGenerator {
3838
return NewKMSKeyGeneratorWithMatDesc(kmsClient, cmkID, MaterialDescription{})
3939
}
@@ -67,7 +67,7 @@ func newKMSKeyHandler(client kmsiface.KMSAPI, cmkID string, matdesc MaterialDesc
6767
// matdesc := s3crypto.MaterialDescription{}
6868
// handler := s3crypto.NewKMSKeyGeneratorWithMatDesc(kms.New(sess), cmkID, matdesc)
6969
//
70-
// deprecated: This feature is in maintenance mode, no new updates will be released. Please see https://docs.aws.amazon.com/general/latest/gr/aws_sdk_cryptography.html for more information.
70+
// Deprecated: This feature is in maintenance mode, no new updates will be released. Please see https://docs.aws.amazon.com/general/latest/gr/aws_sdk_cryptography.html for more information.
7171
func NewKMSKeyGeneratorWithMatDesc(kmsClient kmsiface.KMSAPI, cmkID string, matdesc MaterialDescription) CipherDataGenerator {
7272
return newKMSKeyHandler(kmsClient, cmkID, matdesc)
7373
}
@@ -84,7 +84,7 @@ func NewKMSKeyGeneratorWithMatDesc(kmsClient kmsiface.KMSAPI, cmkID string, matd
8484
// svc.WrapRegistry[s3crypto.KMSWrap] = decryptHandler
8585
// }))
8686
//
87-
// deprecated: This feature is in maintenance mode, no new updates will be released. Please see https://docs.aws.amazon.com/general/latest/gr/aws_sdk_cryptography.html for more information.
87+
// Deprecated: This feature is in maintenance mode, no new updates will be released. Please see https://docs.aws.amazon.com/general/latest/gr/aws_sdk_cryptography.html for more information.
8888
func NewKMSWrapEntry(kmsClient kmsiface.KMSAPI) WrapEntry {
8989
kp := newKMSWrapEntry(kmsClient)
9090
return kp.decryptHandler
@@ -101,7 +101,7 @@ func NewKMSWrapEntry(kmsClient kmsiface.KMSAPI) WrapEntry {
101101
// panic(err) // handle error
102102
// }
103103
//
104-
// deprecated: This feature is in maintenance mode, no new updates will be released. Please see https://docs.aws.amazon.com/general/latest/gr/aws_sdk_cryptography.html for more information.
104+
// Deprecated: This feature is in maintenance mode, no new updates will be released. Please see https://docs.aws.amazon.com/general/latest/gr/aws_sdk_cryptography.html for more information.
105105
func RegisterKMSWrapWithCMK(registry *CryptoRegistry, client kmsiface.KMSAPI, cmkID string) error {
106106
if registry == nil {
107107
return errNilCryptoRegistry
@@ -120,7 +120,7 @@ func RegisterKMSWrapWithCMK(registry *CryptoRegistry, client kmsiface.KMSAPI, cm
120120
// panic(err) // handle error
121121
// }
122122
//
123-
// deprecated: This feature is in maintenance mode, no new updates will be released. Please see https://docs.aws.amazon.com/general/latest/gr/aws_sdk_cryptography.html for more information.
123+
// Deprecated: This feature is in maintenance mode, no new updates will be released. Please see https://docs.aws.amazon.com/general/latest/gr/aws_sdk_cryptography.html for more information.
124124
func RegisterKMSWrapWithAnyCMK(registry *CryptoRegistry, client kmsiface.KMSAPI) error {
125125
if registry == nil {
126126
return errNilCryptoRegistry

0 commit comments

Comments
 (0)