Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

add transfer manager doc header #2990

Merged
merged 2 commits into from
Jan 31, 2025
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions feature/s3/transfermanager/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
// Package transfermanager implements the Amazon S3 Transfer Manager, a
// high-level S3 client library.
//
// Package transfermanager is the new iteration of the original
// [feature/s3/manager] module implemented for the AWS SDK Go v2.
//
// # Beta
//
// This module is currently in a BETA release state. It is not subject to the
// same backwards-compatibility guarantees provided by the generally-available
// (GA) AWS SDK for Go v2. Features may be added or removed without warning,
// and APIs may break.
//
// For the current GA transfer manager for AWS SDK Go v2, see
// [feature/s3/manager].
//
// # Features
//
// Package transfermanager implements a high-level S3 client with support for the
// following:
// - [Client.PutObject] - enhanced object write support w/ automatic
// multipard upload for large objects
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo: multipart

//
// The package also exposes several opt-in hooks that configure an
// http.Transport that may convey performance/reliability enhancements in
// certain user environments:
// - round-robin DNS ([WithRoundRobinDNS])
// - multi-NIC dialer ([WithRotoDialer])
//
// [feature/s3/manager]: https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/feature/s3/manager
package transfermanager