Skip to content

Commit c94df29

Browse files
authored
add transfer manager doc header (#2990)
1 parent 880543c commit c94df29

File tree

1 file changed

+31
-0
lines changed
  • feature/s3/transfermanager

1 file changed

+31
-0
lines changed

feature/s3/transfermanager/doc.go

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
// Package transfermanager implements the Amazon S3 Transfer Manager, a
2+
// high-level S3 client library.
3+
//
4+
// Package transfermanager is the new iteration of the original
5+
// [feature/s3/manager] module implemented for the AWS SDK Go v2.
6+
//
7+
// # Beta
8+
//
9+
// This module is currently in a BETA release state. It is not subject to the
10+
// same backwards-compatibility guarantees provided by the generally-available
11+
// (GA) AWS SDK for Go v2. Features may be added or removed without warning,
12+
// and APIs may break.
13+
//
14+
// For the current GA transfer manager for AWS SDK Go v2, see
15+
// [feature/s3/manager].
16+
//
17+
// # Features
18+
//
19+
// Package transfermanager implements a high-level S3 client with support for the
20+
// following:
21+
// - [Client.PutObject] - enhanced object write support w/ automatic
22+
// multipart upload for large objects
23+
//
24+
// The package also exposes several opt-in hooks that configure an
25+
// http.Transport that may convey performance/reliability enhancements in
26+
// certain user environments:
27+
// - round-robin DNS ([WithRoundRobinDNS])
28+
// - multi-NIC dialer ([WithRotoDialer])
29+
//
30+
// [feature/s3/manager]: https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/feature/s3/manager
31+
package transfermanager

0 commit comments

Comments
 (0)