Skip to content

Commit

Permalink
add note on key name guidance
Browse files Browse the repository at this point in the history
  • Loading branch information
aajtodd committed Mar 18, 2022
1 parent a9f45f3 commit 117f7d5
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions services/s3/e2eTest/S3IntegrationTest.kt
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,11 @@ class S3BucketOpsIntegrationTest {
// this is mostly a stress test of signing w.r.t path encoding (since key is bound
// via @httpLabel) and the ability of an HTTP engine to keep the same encoding going
// out on the wire (e.g. not double percent encoding)

// NOTE: S3 provides guidance on choosing object key names: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html
// This test includes all printable chars (including ones S3 recommends avoiding). Users should
// strive to fall within the guidelines given by S3 though

s3WithAllEngines { s3 ->
val objKey = "foo$PRINTABLE_CHARS"
val content = "hello rfc3986"
Expand Down

0 comments on commit 117f7d5

Please sign in to comment.