s3

package module

Go to main page

Versions in this module

v1

v1.0.1

Apr 18, 2026

Changes in this version

+ const APINotSupported

+ const AccessDenied

+ const AllAccessDisabled

+ const AuthorizationHeaderMalformed

+ const AuthorizationQueryParametersError

+ const BadDigest

+ const BucketAlreadyExists

+ const BucketAlreadyOwnedByYou

+ const BucketNotEmpty

+ const Conflict

+ const ETag

+ const Enabled

+ const EntityTooLarge

+ const EntityTooSmall

+ const GetObjectAttributesMaxParts

+ const GetObjectAttributesTags

+ const IncompleteBody

+ const InternalError

+ const InvalidAccessKeyID

+ const InvalidArgument

+ const InvalidBucketName

+ const InvalidDigest

+ const InvalidDuration

+ const InvalidObjectState

+ const InvalidPart

+ const InvalidPartOrder

+ const InvalidRange

+ const InvalidRegion

+ const MalformedDate

+ const MalformedPOSTRequest

+ const MalformedPolicy

+ const MalformedXML

+ const MaxJitter

+ const MethodNotAllowed

+ const MissingContentLength

+ const MissingContentMD5

+ const MissingFields

+ const MissingRequestBodyError

+ const NoJitter

+ const NoSuchBucket

+ const NoSuchBucketPolicy

+ const NoSuchCORSConfiguration

+ const NoSuchKey

+ const NoSuchTagSet

+ const NoSuchUpload

+ const NoSuchVersion

+ const NotImplemented

+ const PreconditionFailed

+ const QOSConfigVersionCurrent

+ const RequestTimeTooSkewed

+ const RestoreSelect

+ const SignatureDoesNotMatch

+ const Success

+ const Suspended

+ const Testing

+ const TierBulk

+ const TierExpedited

+ const TierStandard

+ const UnexpectedEOF

+ const XAmzContentSHA256Mismatch

+ const XS3InvalidObjectName

+ var DefaultRetryCap = time.Second

+ var DefaultRetryUnit = 200 * time.Millisecond

+ var DefaultTransport = func(secure bool) (*http.Transport, error)

+ var MaxRetry = 10

+ func IsNetworkOrHostDown(err error, expectTimeouts bool) bool

+ func OptimalPartInfo(objectSize int64, configuredPartSize uint64) (totalPartsCount int, partSize, lastPartSize int64, err error)

+ type AccessControlList struct

+ Grant []Grant

+ Permission string

+ XMLName xml.Name

+ type AdvancedGetOptions struct

+ IsReplicationReadyForDeleteMarker bool

+ ReplicationDeleteMarker bool

+ ReplicationProxyRequest string

+ type AdvancedObjectTaggingOptions struct

+ ReplicationProxyRequest string

+ type AdvancedPutOptions struct

+ LegalholdTimestamp time.Time

+ ReplicationRequest bool

+ ReplicationStatus ReplicationStatus

+ ReplicationValidityCheck bool

+ RetentionTimestamp time.Time

+ SourceETag string

+ SourceMTime time.Time

+ SourceVersionID string

+ TaggingTimestamp time.Time

+ type AdvancedRemoveOptions struct

+ ReplicationDeleteMarker bool

+ ReplicationMTime time.Time

+ ReplicationRequest bool

+ ReplicationStatus ReplicationStatus

+ ReplicationValidityCheck bool

+ type AppendObjectOptions struct

+ ChunkSize uint64

+ DisableContentSha256 bool

+ Progress io.Reader

+ func (opts AppendObjectOptions) Header() (header http.Header)

type BucketInfo

+ BucketRegion string

+ type BucketLookupType int

+ const BucketLookupAuto

+ const BucketLookupDNS

+ const BucketLookupPath

+ type BucketOptions = RemoveBucketOptions

+ type BucketVersioningConfiguration struct

+ ExcludeFolders bool

+ ExcludedPrefixes []ExcludedPrefix

+ MFADelete string

+ PurgeOnDelete string

+ Status string

+ XMLName xml.Name

+ func (b BucketVersioningConfiguration) Enabled() bool

+ func (b BucketVersioningConfiguration) Suspended() bool

+ type CSVFileHeaderInfo string

+ const CSVFileHeaderInfoIgnore

+ const CSVFileHeaderInfoNone

+ const CSVFileHeaderInfoUse

+ type CSVInputOptions struct

+ Comments string

+ FieldDelimiter string

+ FileHeaderInfo CSVFileHeaderInfo

+ QuoteCharacter string

+ QuoteEscapeCharacter string

+ RecordDelimiter string

+ func (c *CSVInputOptions) SetComments(val string)

+ func (c *CSVInputOptions) SetFieldDelimiter(val string)

+ func (c *CSVInputOptions) SetFileHeaderInfo(val CSVFileHeaderInfo)

+ func (c *CSVInputOptions) SetQuoteCharacter(val string)

+ func (c *CSVInputOptions) SetQuoteEscapeCharacter(val string)

+ func (c *CSVInputOptions) SetRecordDelimiter(val string)

+ func (c CSVInputOptions) MarshalXML(e *xml.Encoder, start xml.StartElement) error

+ type CSVOutputOptions struct

+ FieldDelimiter string

+ QuoteCharacter string

+ QuoteEscapeCharacter string

+ QuoteFields CSVQuoteFields

+ RecordDelimiter string

+ func (c *CSVOutputOptions) SetFieldDelimiter(val string)

+ func (c *CSVOutputOptions) SetQuoteCharacter(val string)

+ func (c *CSVOutputOptions) SetQuoteEscapeCharacter(val string)

+ func (c *CSVOutputOptions) SetQuoteFields(val CSVQuoteFields)

+ func (c *CSVOutputOptions) SetRecordDelimiter(val string)

+ func (c CSVOutputOptions) MarshalXML(e *xml.Encoder, start xml.StartElement) error

+ type CSVQuoteFields string

+ const CSVQuoteFieldsAlways

+ const CSVQuoteFieldsAsNeeded

+ type Checksum struct

+ Type ChecksumType

+ func NewChecksum(t ChecksumType, b []byte) Checksum

+ func NewChecksumString(t ChecksumType, s string) Checksum

+ func (c Checksum) Encoded() string

+ func (c Checksum) IsSet() bool

+ func (c Checksum) Raw() []byte

+ type ChecksumMode uint32

+ const ChecksumCompositeMode

+ const ChecksumFullObjectMode

+ func (c ChecksumMode) Is(t ChecksumMode) bool

+ func (c ChecksumMode) Key() string

+ func (c ChecksumMode) String() string

+ type ChecksumType uint32

+ const ChecksumCRC32

+ const ChecksumCRC32C

+ const ChecksumCRC64NVME

+ const ChecksumFullObject

+ const ChecksumFullObjectCRC32

+ const ChecksumFullObjectCRC32C

+ const ChecksumNone

+ const ChecksumSHA1

+ const ChecksumSHA256

+ func (c *ChecksumType) SetDefault(t ChecksumType)

+ func (c ChecksumType) Base() ChecksumType

+ func (c ChecksumType) CanComposite() bool

+ func (c ChecksumType) CanMergeCRC() bool

+ func (c ChecksumType) ChecksumBytes(b []byte) Checksum

+ func (c ChecksumType) ChecksumReader(r io.Reader) (Checksum, error)

+ func (c ChecksumType) CompositeChecksum(p []ObjectPart) (*Checksum, error)

+ func (c ChecksumType) EncodeToString(b []byte) string

+ func (c ChecksumType) FullObjectChecksum(p []ObjectPart) (*Checksum, error)

+ func (c ChecksumType) FullObjectRequested() bool

+ func (c ChecksumType) Hasher() hash.Hash

+ func (c ChecksumType) Is(t ChecksumType) bool

+ func (c ChecksumType) IsSet() bool

+ func (c ChecksumType) Key() string

+ func (c ChecksumType) KeyCapitalized() string

+ func (c ChecksumType) RawByteLen() int

+ func (c ChecksumType) String() string

type Client

+ func (c *Client) AppendObject(ctx context.Context, bucketName, objectName string, reader io.Reader, ...) (info UploadInfo, err error)

+ func (c *Client) CancelBucketReplicationResync(ctx context.Context, bucketName string, tgtArn string) (id string, err error)

+ func (c *Client) CheckBucketReplication(ctx context.Context, bucketName string) (err error)

+ func (c *Client) ComposeObject(ctx context.Context, dst CopyDestOptions, srcs ...CopySrcOptions) (UploadInfo, error)

+ func (c *Client) CopyObject(ctx context.Context, dst CopyDestOptions, src CopySrcOptions) (UploadInfo, error)

+ func (c *Client) CreateSession(ctx context.Context, bucketName string, sessionMode SessionMode) (cred credentials.Value, err error)

+ func (c *Client) CredContext() *credentials.CredContext

+ func (c *Client) DeleteBucketInventoryConfiguration(ctx context.Context, bucket, id string) error

+ func (c *Client) EnableVersioning(ctx context.Context, bucketName string) error

+ func (c *Client) EndpointURL() *url.URL

+ func (c *Client) GenerateInventoryConfigYAML(ctx context.Context, bucket, id string) (string, error)

+ func (c *Client) GetBucketCors(ctx context.Context, bucketName string) (*cors.Config, error)

+ func (c *Client) GetBucketEncryption(ctx context.Context, bucketName string) (*sse.Configuration, error)

+ func (c *Client) GetBucketInventoryConfiguration(ctx context.Context, bucket, id string) (*InventoryConfiguration, error)

+ func (c *Client) GetBucketInventoryJobStatus(ctx context.Context, bucket, id string) (*InventoryJobStatus, error)

+ func (c *Client) GetBucketLifecycle(ctx context.Context, bucketName string) (*lifecycle.Configuration, error)

+ func (c *Client) GetBucketLifecycleWithInfo(ctx context.Context, bucketName string) (*lifecycle.Configuration, time.Time, error)

+ func (c *Client) GetBucketLocation(ctx context.Context, bucketName string) (string, error)

+ func (c *Client) GetBucketNotification(ctx context.Context, bucketName string) (bucketNotification notification.Configuration, err error)

+ func (c *Client) GetBucketObjectLockConfig(ctx context.Context, bucketName string) (mode *RetentionMode, validity *uint, unit *ValidityUnit, err error)

+ func (c *Client) GetBucketPolicy(ctx context.Context, bucketName string) (string, error)

+ func (c *Client) GetBucketQOS(ctx context.Context, bucket string) (*QOSConfig, error)

+ func (c *Client) GetBucketQOSMetrics(ctx context.Context, bucketName, nodeName string) (qs []QOSNodeStats, err error)

+ func (c *Client) GetBucketReplication(ctx context.Context, bucketName string) (cfg replication.Config, err error)

+ func (c *Client) GetBucketReplicationMetrics(ctx context.Context, bucketName string) (s replication.Metrics, err error)

+ func (c *Client) GetBucketReplicationMetricsV2(ctx context.Context, bucketName string) (s replication.MetricsV2, err error)

+ func (c *Client) GetBucketReplicationResyncStatus(ctx context.Context, bucketName, arn string) (rinfo replication.ResyncTargetsInfo, err error)

+ func (c *Client) GetBucketTagging(ctx context.Context, bucketName string) (*tags.Tags, error)

+ func (c *Client) GetBucketVersioning(ctx context.Context, bucketName string) (BucketVersioningConfiguration, error)

+ func (c *Client) GetCreds() (credentials.Value, error)

+ func (c *Client) GetObjectACL(ctx context.Context, bucketName, objectName string) (*ObjectInfo, error)

+ func (c *Client) GetObjectAttributes(ctx context.Context, bucketName, objectName string, ...) (*ObjectAttributes, error)

+ func (c *Client) GetObjectLegalHold(ctx context.Context, bucketName, objectName string, ...) (status *LegalHoldStatus, err error)

+ func (c *Client) GetObjectLockConfig(ctx context.Context, bucketName string) (objectLock string, mode *RetentionMode, validity *uint, unit *ValidityUnit, ...)

+ func (c *Client) GetObjectRetention(ctx context.Context, bucketName, objectName, versionID string) (mode *RetentionMode, retainUntilDate *time.Time, err error)

+ func (c *Client) GetObjectTagging(ctx context.Context, bucketName, objectName string, ...) (*tags.Tags, error)

+ func (c *Client) HealthCheck(hcDuration time.Duration) (context.CancelFunc, error)

+ func (c *Client) IsOffline() bool

+ func (c *Client) IsOnline() bool

+ func (c *Client) ListBucketInventoryConfigurations(ctx context.Context, bucket, continuationToken string) (lr *InventoryListResult, err error)

+ func (c *Client) ListBucketInventoryConfigurationsIterator(ctx context.Context, bucket string) iter.Seq2[InventoryConfiguration, error]

+ func (c *Client) ListDirectoryBuckets(ctx context.Context) (iter.Seq2[BucketInfo, error], error)

+ func (c *Client) ListObjectsIter(ctx context.Context, bucketName string, opts ListObjectsOptions) iter.Seq[ObjectInfo]

+ func (c *Client) ListenBucketNotification(ctx context.Context, bucketName, prefix, suffix string, events []string) <-chan notification.Info

+ func (c *Client) ListenNotification(ctx context.Context, prefix, suffix string, events []string) <-chan notification.Info

+ func (c *Client) Presign(ctx context.Context, method, bucketName, objectName string, ...) (u *url.URL, err error)

+ func (c *Client) PresignHeader(ctx context.Context, method, bucketName, objectName string, ...) (u *url.URL, err error)

+ func (c *Client) PresignedHeadObject(ctx context.Context, bucketName, objectName string, expires time.Duration, ...) (u *url.URL, err error)

+ func (c *Client) PromptObject(ctx context.Context, bucketName, objectName, prompt string, ...) (io.ReadCloser, error)

+ func (c *Client) PutBucketInventoryConfiguration(ctx context.Context, bucket string, id string, yamlDef string, ...) error

+ func (c *Client) PutObjectFanOut(ctx context.Context, bucket string, fanOutData io.Reader, ...) ([]PutObjectFanOutResponse, error)

+ func (c *Client) PutObjectLegalHold(ctx context.Context, bucketName, objectName string, ...) error

+ func (c *Client) PutObjectRetention(ctx context.Context, bucketName, objectName string, ...) error

+ func (c *Client) PutObjectTagging(ctx context.Context, bucketName, objectName string, otags *tags.Tags, ...) error

+ func (c *Client) PutObjectsSnowball(ctx context.Context, bucketName string, opts SnowballOptions, ...) (err error)

+ func (c *Client) RemoveAllBucketNotification(ctx context.Context, bucketName string) error

+ func (c *Client) RemoveBucketEncryption(ctx context.Context, bucketName string) error

+ func (c *Client) RemoveBucketReplication(ctx context.Context, bucketName string) error

+ func (c *Client) RemoveBucketTagging(ctx context.Context, bucketName string) error

+ func (c *Client) RemoveBucketWithOptions(ctx context.Context, bucketName string, opts RemoveBucketOptions) error

+ func (c *Client) RemoveObjectTagging(ctx context.Context, bucketName, objectName string, ...) error

+ func (c *Client) RemoveObjects(ctx context.Context, bucketName string, objectsCh <-chan ObjectInfo, ...) <-chan RemoveObjectError

+ func (c *Client) RemoveObjectsWithIter(ctx context.Context, bucketName string, objectsIter iter.Seq[ObjectInfo], ...) (iter.Seq[RemoveObjectResult], error)

+ func (c *Client) RemoveObjectsWithResult(ctx context.Context, bucketName string, objectsCh <-chan ObjectInfo, ...) <-chan RemoveObjectResult

+ func (c *Client) ResetBucketReplication(ctx context.Context, bucketName string, olderThan time.Duration) (rID string, err error)

+ func (c *Client) ResetBucketReplicationOnTarget(ctx context.Context, bucketName string, olderThan time.Duration, tgtArn string) (replication.ResyncTargetsInfo, error)

+ func (c *Client) RestoreObject(ctx context.Context, bucketName, objectName, versionID string, ...) error

+ func (c *Client) SelectObjectContent(ctx context.Context, bucketName, objectName string, opts SelectObjectOptions) (*SelectResults, error)

+ func (c *Client) SetBucketCors(ctx context.Context, bucketName string, corsConfig *cors.Config) error

+ func (c *Client) SetBucketEncryption(ctx context.Context, bucketName string, config *sse.Configuration) error

+ func (c *Client) SetBucketLifecycle(ctx context.Context, bucketName string, config *lifecycle.Configuration) error

+ func (c *Client) SetBucketNotification(ctx context.Context, bucketName string, config notification.Configuration) error

+ func (c *Client) SetBucketObjectLockConfig(ctx context.Context, bucketName string, mode *RetentionMode, validity *uint, ...) error

+ func (c *Client) SetBucketPolicy(ctx context.Context, bucketName, policy string) error

+ func (c *Client) SetBucketQOS(ctx context.Context, bucket string, qosCfg *QOSConfig) error

+ func (c *Client) SetBucketReplication(ctx context.Context, bucketName string, cfg replication.Config) error

+ func (c *Client) SetBucketTagging(ctx context.Context, bucketName string, tags *tags.Tags) error

+ func (c *Client) SetBucketVersioning(ctx context.Context, bucketName string, config BucketVersioningConfiguration) error

+ func (c *Client) SetObjectLockConfig(ctx context.Context, bucketName string, mode *RetentionMode, validity *uint, ...) error

+ func (c *Client) SetS3EnableDualstack(enabled bool)

+ func (c *Client) SetS3TransferAccelerate(accelerateEndpoint string)

+ func (c *Client) SuspendVersioning(ctx context.Context, bucketName string) error

+ func (c *Client) TraceErrorsOnlyOff()

+ func (c *Client) TraceErrorsOnlyOn(outputStream io.Writer)

+ type CommonPrefix struct

+ Prefix string

+ type CompletePart struct

+ ChecksumCRC32 string

+ ChecksumCRC32C string

+ ChecksumCRC64NVME string

+ ChecksumSHA1 string

+ ChecksumSHA256 string

+ ETag string

+ PartNumber int

+ func (c CompletePart) Checksum(t ChecksumType) string

+ type CopyDestOptions struct

+ Bucket string

+ CacheControl string

+ ChecksumType ChecksumType

+ ContentDisposition string

+ ContentEncoding string

+ ContentLanguage string

+ ContentType string

+ Encryption encrypt.ServerSide

+ Expires time.Time

+ LegalHold LegalHoldStatus

+ Mode RetentionMode

+ Object string

+ PartSize uint64

+ Progress io.Reader

+ ReplaceMetadata bool

+ ReplaceTags bool

+ RetainUntilDate time.Time

+ Size int64

+ UserMetadata map[string]string

+ UserTags map[string]string

+ func (opts CopyDestOptions) Marshal(header http.Header)

+ type CopySrcOptions struct

+ Bucket string

+ Encryption encrypt.ServerSide

+ End int64

+ MatchETag string

+ MatchModifiedSince time.Time

+ MatchRange bool

+ MatchUnmodifiedSince time.Time

+ NoMatchETag string

+ Object string

+ Start int64

+ VersionID string

+ func (opts CopySrcOptions) Marshal(header http.Header)

+ type Core struct

+ func NewCore(endpoint string, opts *Options) (*Core, error)

+ func (c Core) AbortMultipartUpload(ctx context.Context, bucket, object, uploadID string) error

+ func (c Core) CompleteMultipartUpload(ctx context.Context, bucket, object, uploadID string, parts []CompletePart, ...) (UploadInfo, error)

+ func (c Core) CopyObject(ctx context.Context, sourceBucket, sourceObject, destBucket, destObject string, ...) (ObjectInfo, error)

+ func (c Core) CopyObjectPart(ctx context.Context, ...) (p CompletePart, err error)

+ func (c Core) GetBucketPolicy(ctx context.Context, bucket string) (string, error)

+ func (c Core) GetObject(ctx context.Context, bucketName, objectName string, opts GetObjectOptions) (io.ReadCloser, ObjectInfo, http.Header, error)

+ func (c Core) ListMultipartUploads(ctx context.Context, ...) (result ListMultipartUploadsResult, err error)

+ func (c Core) ListObjectParts(ctx context.Context, bucket, object, uploadID string, ...) (result ListObjectPartsResult, err error)

+ func (c Core) ListObjects(bucket, prefix, marker, delimiter string, maxKeys int) (result ListBucketResult, err error)

+ func (c Core) ListObjectsV2(bucketName, objectPrefix, startAfter, continuationToken, delimiter string, ...) (ListBucketV2Result, error)

+ func (c Core) NewMultipartUpload(ctx context.Context, bucket, object string, opts PutObjectOptions) (uploadID string, err error)

+ func (c Core) PutBucketPolicy(ctx context.Context, bucket, bucketPolicy string) error

+ func (c Core) PutObject(ctx context.Context, bucket, object string, data io.Reader, size int64, ...) (UploadInfo, error)

+ func (c Core) PutObjectPart(ctx context.Context, bucket, object, uploadID string, partID int, ...) (ObjectPart, error)

+ type CounterMetric struct

+ Last1hr uint64

+ Last1m uint64

+ Total uint64

+ type Encryption struct

+ EncryptionType string

+ KMSContext string

+ KMSKeyID string

type ErrorResponse

+ Region string

+ Server string

+ StatusCode int

+ type ExcludedPrefix struct

+ Prefix string

+ type GetObjectLegalHoldOptions struct

+ VersionID string

+ type GetObjectOptions struct

+ Checksum bool

+ Internal AdvancedGetOptions

+ PartNumber int

+ ServerSideEncryption encrypt.ServerSide

+ VersionID string

+ func (o *GetObjectOptions) AddReqParam(key, value string)

+ func (o *GetObjectOptions) Set(key, value string)

+ func (o *GetObjectOptions) SetMatchETag(etag string) error

+ func (o *GetObjectOptions) SetMatchETagExcept(etag string) error

+ func (o *GetObjectOptions) SetModified(modTime time.Time) error

+ func (o *GetObjectOptions) SetRange(start, end int64) error

+ func (o *GetObjectOptions) SetReqParam(key, value string)

+ func (o *GetObjectOptions) SetUnmodified(modTime time.Time) error

+ func (o GetObjectOptions) Header() http.Header

+ type GetObjectTaggingOptions struct

+ Internal AdvancedObjectTaggingOptions

+ VersionID string

+ type GlacierJobParameters struct

+ Tier TierType

+ type Grant struct

+ Grantee Grantee

+ Permission string

+ XMLName xml.Name

+ type Grantee struct

+ DisplayName string

+ ID string

+ URI string

+ XMLName xml.Name

+ type InventoryConfiguration struct

+ Bucket string

+ ID string

+ User string

+ YamlDef string

+ type InventoryJobStatus struct

+ AccessKey string

+ Bucket string

+ EndTime time.Time

+ ExecutionTime string

+ ID string

+ LastFailErrors []string

+ LastFailTime time.Time

+ LastUpdate time.Time

+ ManifestPath string

+ Matched string

+ MatchedCount uint64

+ NextScheduledTime time.Time

+ NumErrors uint64

+ NumLockLosses uint64

+ NumStarts uint64

+ OutputFilesCount uint64

+ RecordsWritten uint64

+ RetryAttempts uint64

+ Scanned string

+ ScannedCount uint64

+ Schedule string

+ StartTime time.Time

+ State string

+ User string

+ type InventoryListResult struct

+ Items []InventoryConfiguration

+ NextContinuationToken string

+ type InventoryPutConfigOption func(*inventoryPutConfigOpts)

+ type JSONInputOptions struct

+ Type JSONType

+ func (j *JSONInputOptions) SetType(typ JSONType)

+ func (j JSONInputOptions) MarshalXML(e *xml.Encoder, start xml.StartElement) error

+ type JSONOutputOptions struct

+ RecordDelimiter string

+ func (j *JSONOutputOptions) SetRecordDelimiter(val string)

+ func (j JSONOutputOptions) MarshalXML(e *xml.Encoder, start xml.StartElement) error

+ type JSONType string

+ const JSONDocumentType

+ const JSONLinesType

+ type LegalHoldStatus string

+ const LegalHoldDisabled

+ const LegalHoldEnabled

+ func (r LegalHoldStatus) IsValid() bool

+ func (r LegalHoldStatus) String() string

+ type ListBucketResult struct

+ CommonPrefixes []CommonPrefix

+ Contents []ObjectInfo

+ Delimiter string

+ EncodingType string

+ IsTruncated bool

+ Marker string

+ MaxKeys int64

+ Name string

+ NextMarker string

+ Prefix string

+ type ListBucketV2Result struct

+ CommonPrefixes []CommonPrefix

+ Contents []ObjectInfo

+ ContinuationToken string

+ Delimiter string

+ EncodingType string

+ FetchOwner string

+ IsTruncated bool

+ MaxKeys int64

+ Name string

+ NextContinuationToken string

+ Prefix string

+ StartAfter string

+ type ListMultipartUploadsResult struct

+ Bucket string

+ CommonPrefixes []CommonPrefix

+ Delimiter string

+ EncodingType string

+ IsTruncated bool

+ KeyMarker string

+ MaxUploads int64

+ NextKeyMarker string

+ NextUploadIDMarker string

+ Prefix string

+ UploadIDMarker string

+ Uploads []ObjectMultipartInfo

+ type ListObjectPartsResult struct

+ Bucket string

+ ChecksumAlgorithm string

+ ChecksumType string

+ EncodingType string

+ Initiator initiator

+ IsTruncated bool

+ Key string

+ MaxParts int

+ NextPartNumberMarker int

+ ObjectParts []ObjectPart

+ Owner owner

+ PartNumberMarker int

+ StorageClass string

+ UploadID string

+ type ListObjectsOptions struct

+ MaxKeys int

+ Prefix string

+ Recursive bool

+ ReverseVersions bool

+ StartAfter string

+ UseV1 bool

+ WithMetadata bool

+ WithVersions bool

+ func (o *ListObjectsOptions) Set(key, value string)

+ type ListVersionsResult struct

+ CommonPrefixes []CommonPrefix

+ Delimiter string

+ EncodingType string

+ IsTruncated bool

+ KeyMarker string

+ MaxKeys int64

+ Name string

+ NextKeyMarker string

+ NextVersionIDMarker string

+ Prefix string

+ VersionIDMarker string

+ Versions []Version

+ func (l *ListVersionsResult) UnmarshalXML(d *xml.Decoder, _ xml.StartElement) (err error)

+ type MakeBucketOptions struct

+ ForceCreate bool

+ ObjectLocking bool

+ Region string

+ type MetadataEntry struct

+ Name string

+ Value string

+ type ObjectAttributePart struct

+ ChecksumCRC32 string

+ ChecksumCRC32C string

+ ChecksumSHA1 string

+ ChecksumSHA256 string

+ PartNumber int

+ Size int

+ type ObjectAttributes struct

+ LastModified time.Time

+ VersionID string

+ type ObjectAttributesOptions struct

+ MaxParts int

+ PartNumberMarker int

+ ServerSideEncryption encrypt.ServerSide

+ VersionID string

+ type ObjectAttributesResponse struct

+ Checksum struct{ ... }

+ ETag string

+ ObjectParts struct{ ... }

+ ObjectSize int

+ StorageClass string

type ObjectInfo

+ ChecksumCRC32 string

+ ChecksumCRC32C string

+ ChecksumCRC64NVME string

+ ChecksumMode string

+ ChecksumSHA1 string

+ ChecksumSHA256 string

+ Expiration time.Time

+ ExpirationRuleID string

+ Expires time.Time

+ Grant []Grant

+ Internal ...

+ IsDeleteMarker bool

+ IsLatest bool

+ Metadata http.Header

+ NumVersions int

+ ReplicationReady bool

+ ReplicationStatus string

+ Restore *RestoreInfo

+ UserMetadata StringMap

+ UserTagCount int

+ UserTags URLMap

+ VersionID string

+ func ToObjectInfo(bucketName, objectName string, h http.Header) (ObjectInfo, error)

+ type ObjectPart struct

+ ChecksumCRC32 string

+ ChecksumCRC32C string

+ ChecksumCRC64NVME string

+ ChecksumSHA1 string

+ ChecksumSHA256 string

+ ETag string

+ LastModified time.Time

+ PartNumber int

+ Size int64

+ func (c ObjectPart) Checksum(t ChecksumType) string

+ func (c ObjectPart) ChecksumRaw(t ChecksumType) ([]byte, error)

+ type Options struct

+ BucketLookup BucketLookupType

+ BucketLookupViaURL func(u url.URL, bucketName string) BucketLookupType

+ Creds *credentials.Credentials

+ CustomMD5 func() md5simd.Hasher

+ CustomRegionViaURL func(u url.URL) string

+ CustomSHA256 func() md5simd.Hasher

+ MaxRetries int

+ Region string

+ Secure bool

+ Trace *httptrace.ClientTrace

+ TrailingHeaders bool

+ Transport http.RoundTripper

+ type OutputLocation struct

+ S3 S3

+ XMLName xml.Name

+ type Owner struct

+ DisplayName string

+ ID string

+ XMLName xml.Name

+ type ParquetInputOptions struct

type PostPolicy

+ func (p *PostPolicy) SetChecksum(c Checksum) error

+ func (p *PostPolicy) SetCondition(matchType, condition, value string) error

+ func (p *PostPolicy) SetContentDisposition(contentDisposition string) error

+ func (p *PostPolicy) SetContentEncoding(contentEncoding string) error

+ func (p *PostPolicy) SetContentTypeStartsWith(contentTypeStartsWith string) error

+ func (p *PostPolicy) SetEncryption(sse encrypt.ServerSide)

+ func (p *PostPolicy) SetSuccessActionRedirect(redirect string) error

+ func (p *PostPolicy) SetSuccessStatusAction(status string) error

+ func (p *PostPolicy) SetTagging(tagging string) error

+ func (p *PostPolicy) SetUserData(key, value string) error

+ func (p *PostPolicy) SetUserMetadata(key, value string) error

+ func (p *PostPolicy) SetUserMetadataStartsWith(key, value string) error

+ type ProgressMessage struct

+ XMLName xml.Name

+ type PromptObjectOptions struct

+ LambdaArn string

+ PromptArgs map[string]any

+ func (o *PromptObjectOptions) AddLambdaArnToReqParams(lambdaArn string)

+ func (o *PromptObjectOptions) AddPromptArg(key string, value any)

+ func (o *PromptObjectOptions) SetHeader(key, value string)

+ func (o PromptObjectOptions) Header() http.Header

+ type PutObjectFanOutEntry struct

+ CacheControl string

+ ContentDisposition string

+ ContentEncoding string

+ ContentLanguage string

+ ContentType string

+ Key string

+ RetainUntilDate *time.Time

+ Retention RetentionMode

+ UserMetadata map[string]string

+ UserTags map[string]string

+ type PutObjectFanOutRequest struct

+ Checksum Checksum

+ Entries []PutObjectFanOutEntry

+ SSE encrypt.ServerSide

+ type PutObjectFanOutResponse struct

+ ETag string

+ Error string

+ Key string

+ LastModified *time.Time

+ VersionID string

+ type PutObjectLegalHoldOptions struct

+ Status *LegalHoldStatus

+ VersionID string

+ type PutObjectOptions struct

+ AutoChecksum ChecksumType

+ CacheControl string

+ Checksum ChecksumType

+ ConcurrentStreamParts bool

+ ContentDisposition string

+ ContentEncoding string

+ ContentLanguage string

+ ContentType string

+ DisableContentSha256 bool

+ DisableMultipart bool

+ Expires time.Time

+ Internal AdvancedPutOptions

+ LegalHold LegalHoldStatus

+ Mode RetentionMode

+ NumThreads uint

+ PartSize uint64

+ Progress io.Reader

+ RetainUntilDate time.Time

+ SendContentMd5 bool

+ ServerSideEncryption encrypt.ServerSide

+ StorageClass string

+ UserMetadata map[string]string

+ UserTags map[string]string

+ WebsiteRedirectLocation string

+ func (opts *PutObjectOptions) SetMatchETag(etag string)

+ func (opts *PutObjectOptions) SetMatchETagExcept(etag string)

+ func (opts PutObjectOptions) Header() (header http.Header)

+ type PutObjectPartOptions struct

+ CustomHeader http.Header

+ DisableContentSha256 bool

+ Md5Base64 string

+ SSE encrypt.ServerSide

+ Sha256Hex string

+ Trailer http.Header

+ type PutObjectRetentionOptions struct

+ GovernanceBypass bool

+ Mode *RetentionMode

+ RetainUntilDate *time.Time

+ VersionID string

+ type PutObjectTaggingOptions struct

+ Internal AdvancedObjectTaggingOptions

+ VersionID string

+ type QOSConfig struct

+ Rules []QOSRule

+ Version string

+ func NewQOSConfig() *QOSConfig

+ type QOSMetric struct

+ APIName string

+ ClientDisconnCount CounterMetric

+ ExceededRateLimit CounterMetric

+ ReqTimeoutCount CounterMetric

+ Rule QOSRule

+ Throttled CounterMetric

+ Totals CounterMetric

+ type QOSNodeStats struct

+ NodeName string

+ Stats []QOSMetric

+ type QOSRule struct

+ API string

+ Burst int64

+ ID string

+ Label string

+ Limit string

+ ObjectPrefix string

+ Priority int

+ Rate int64

+ type QueryExpressionType string

+ const QueryExpressionTypeSQL

+ type RemoveBucketOptions struct

+ ForceDelete bool

+ type RemoveObjectError struct

+ Err error

+ ObjectName string

+ VersionID string

+ func (err *RemoveObjectError) Error() string

+ type RemoveObjectOptions struct

+ ForceDelete bool

+ GovernanceBypass bool

+ Internal AdvancedRemoveOptions

+ VersionID string

+ type RemoveObjectResult struct

+ DeleteMarker bool

+ DeleteMarkerVersionID string

+ Err error

+ ObjectName string

+ ObjectVersionID string

+ type RemoveObjectTaggingOptions struct

+ Internal AdvancedObjectTaggingOptions

+ VersionID string

+ type RemoveObjectsOptions struct

+ GovernanceBypass bool

+ type ReplicationStatus string

+ const ReplicationStatusComplete

+ const ReplicationStatusFailed

+ const ReplicationStatusPending

+ const ReplicationStatusReplica

+ const ReplicationStatusReplicaEdge

+ func (r ReplicationStatus) Empty() bool

+ type RestoreInfo struct

+ ExpiryTime time.Time

+ OngoingRestore bool

+ type RestoreRequest struct

+ Days *int

+ Description *string

+ GlacierJobParameters *GlacierJobParameters

+ OutputLocation *OutputLocation

+ SelectParameters *SelectParameters

+ Tier *TierType

+ Type *RestoreType

+ XMLName xml.Name

+ func (r *RestoreRequest) SetDays(v int)

+ func (r *RestoreRequest) SetDescription(v string)

+ func (r *RestoreRequest) SetGlacierJobParameters(v GlacierJobParameters)

+ func (r *RestoreRequest) SetOutputLocation(v OutputLocation)

+ func (r *RestoreRequest) SetSelectParameters(v SelectParameters)

+ func (r *RestoreRequest) SetTier(v TierType)

+ func (r *RestoreRequest) SetType(v RestoreType)

+ type RestoreType string

+ type Retention struct

+ Mode RetentionMode

+ Validity time.Duration

+ func (r Retention) IsEmpty() bool

+ func (r Retention) String() string

+ type RetentionMode string

+ const Compliance

+ const Governance

+ func (r RetentionMode) IsValid() bool

+ func (r RetentionMode) String() string

+ type S3 struct

+ AccessControlList *AccessControlList

+ BucketName string

+ CannedACL *string

+ Encryption *Encryption

+ Prefix string

+ StorageClass *string

+ Tagging *tags.Tags

+ UserMetadata *MetadataEntry

+ type SelectCompressionType string

+ const SelectCompressionBZIP

+ const SelectCompressionGZIP

+ const SelectCompressionLZ4

+ const SelectCompressionNONE

+ const SelectCompressionS2

+ const SelectCompressionSNAPPY

+ const SelectCompressionZSTD

+ type SelectObjectInputSerialization struct

+ CSV *CSVInputOptions

+ CompressionType SelectCompressionType

+ JSON *JSONInputOptions

+ Parquet *ParquetInputOptions

+ type SelectObjectOptions struct

+ Expression string

+ ExpressionType QueryExpressionType

+ InputSerialization SelectObjectInputSerialization

+ OutputSerialization SelectObjectOutputSerialization

+ RequestProgress struct{ ... }

+ ServerSideEncryption encrypt.ServerSide

+ XMLName xml.Name

+ func (o SelectObjectOptions) Header() http.Header

+ type SelectObjectOutputSerialization struct

+ CSV *CSVOutputOptions

+ JSON *JSONOutputOptions

+ type SelectObjectType string

+ const SelectObjectTypeCSV

+ const SelectObjectTypeJSON

+ const SelectObjectTypeParquet

+ type SelectParameters struct

+ Expression string

+ ExpressionType QueryExpressionType

+ InputSerialization SelectObjectInputSerialization

+ OutputSerialization SelectObjectOutputSerialization

+ XMLName xml.Name

+ type SelectResults struct

+ func NewSelectResults(resp *http.Response, bucketName string) (*SelectResults, error)

+ func (s *SelectResults) Close() error

+ func (s *SelectResults) Progress() *ProgressMessage

+ func (s *SelectResults) Read(b []byte) (n int, err error)

+ func (s *SelectResults) Stats() *StatsMessage

+ type SessionMode string

+ const SessionReadOnly

+ const SessionReadWrite

+ type SnowballObject struct

+ Close func()

+ Content io.Reader

+ Headers http.Header

+ Key string

+ ModTime time.Time

+ Size int64

+ VersionID string

+ type SnowballOptions struct

+ Compress bool

+ InMemory bool

+ Opts PutObjectOptions

+ SkipErrs bool

+ type StatObjectOptions = GetObjectOptions

+ type StatsMessage struct

+ BytesProcessed int64

+ BytesReturned int64

+ BytesScanned int64

+ XMLName xml.Name

+ type StringMap map[string]string

+ func (m *StringMap) UnmarshalXML(d *xml.Decoder, _ xml.StartElement) error

+ type TierType string

+ type URLMap map[string]string

+ func (m *URLMap) UnmarshalXML(d *xml.Decoder, se xml.StartElement) error

+ type UploadInfo struct

+ Bucket string

+ ChecksumCRC32 string

+ ChecksumCRC32C string

+ ChecksumCRC64NVME string

+ ChecksumMode string

+ ChecksumSHA1 string

+ ChecksumSHA256 string

+ ETag string

+ Expiration time.Time

+ ExpirationRuleID string

+ Key string

+ LastModified time.Time

+ Location string

+ Size int64

+ VersionID string

+ type ValidityUnit string

+ const Days

+ const Years

+ func (unit ValidityUnit) String() string

+ type Version struct

+ ChecksumCRC32 string

+ ChecksumCRC32C string

+ ChecksumCRC64NVME string

+ ChecksumSHA1 string

+ ChecksumSHA256 string

+ ChecksumType string

+ ETag string

+ Internal ...

+ IsLatest bool

+ Key string

+ LastModified time.Time

+ Owner Owner

+ Size int64

+ StorageClass string

+ UserMetadata StringMap

+ UserTags URLMap

+ VersionID string

v1.0.0

Feb 18, 2016

Changes in this version

+ var ErrInvalidObjectPrefix = ErrInvalidObjectName

+ func ErrEntityTooLarge(totalSize, maxObjectSize int64, bucketName, objectName string) error

+ func ErrEntityTooSmall(totalSize int64, bucketName, objectName string) error

+ func ErrInvalidArgument(message string) error

+ func ErrInvalidBucketName(message string) error

+ func ErrInvalidObjectName(message string) error

+ func ErrInvalidParts(expectedParts, uploadedParts int) error

+ func ErrUnexpectedEOF(totalRead, totalSize int64, bucketName, objectName string) error

+ type BucketInfo struct

+ CreationDate time.Time

+ Name string

+ type Client struct

+ func NewV2(endpoint string, accessKeyID, secretAccessKey string, insecure bool) (*Client, error)

+ func NewV4(endpoint string, accessKeyID, secretAccessKey string, insecure bool) (*Client, error)

+ func (c *Client) SetAppInfo(appName string, appVersion string)

+ func (c *Client) SetCustomTransport(customHTTPTransport http.RoundTripper)

+ func (c *Client) TraceOff()

+ func (c *Client) TraceOn(outputStream io.Writer)

+ func (c Client) BucketExists(bucketName string) error

+ func (c Client) FGetObject(bucketName, objectName, filePath string) error

+ func (c Client) FPutObject(bucketName, objectName, filePath, contentType string) (n int64, err error)

+ func (c Client) GetBucketACL(bucketName string) (BucketACL, error)

+ func (c Client) GetObject(bucketName, objectName string) (*Object, error)

+ func (c Client) ListBuckets() ([]BucketInfo, error)

+ func (c Client) ListIncompleteUploads(bucketName, objectPrefix string, recursive bool, doneCh <-chan struct{}) <-chan ObjectMultipartInfo

+ func (c Client) ListObjects(bucketName, objectPrefix string, recursive bool, doneCh <-chan struct{}) <-chan ObjectInfo

+ func (c Client) MakeBucket(bucketName string, acl BucketACL, location string) error

+ func (c Client) PresignedGetObject(bucketName string, objectName string, expires time.Duration, ...) (url string, err error)

+ func (c Client) PresignedPostPolicy(p *PostPolicy) (map[string]string, error)

+ func (c Client) PresignedPutObject(bucketName string, objectName string, expires time.Duration) (url string, err error)

+ func (c Client) PutObject(bucketName, objectName string, reader io.Reader, contentType string) (n int64, err error)

+ func (c Client) PutObjectWithProgress(bucketName, objectName string, reader io.Reader, contentType string, ...) (n int64, err error)

+ func (c Client) RemoveBucket(bucketName string) error

+ func (c Client) RemoveIncompleteUpload(bucketName, objectName string) error

+ func (c Client) RemoveObject(bucketName, objectName string) error

+ func (c Client) SetBucketACL(bucketName string, acl BucketACL) error

+ func (c Client) StatObject(bucketName, objectName string) (ObjectInfo, error)

type ErrorResponse

+ AmzBucketRegion string

+ BucketName string

+ Key string

+ type Object struct

+ func (o *Object) Close() (err error)

+ func (o *Object) Read(b []byte) (n int, err error)

+ func (o *Object) ReadAt(b []byte, offset int64) (n int, err error)

+ func (o *Object) Seek(offset int64, whence int) (n int64, err error)

+ func (o *Object) Stat() (ObjectInfo, error)

+ type ObjectInfo struct

+ ContentType string

+ ETag string

+ Err error

+ Key string

+ LastModified time.Time

+ Owner struct{ ... }

+ Size int64

+ StorageClass string

+ type ObjectMultipartInfo struct

+ Err error

+ Initiated time.Time

+ Initiator initiator

+ Key string

+ Owner owner

+ Size int64

+ StorageClass string

+ UploadID string

+ type PostPolicy struct

+ func NewPostPolicy() *PostPolicy

+ func (p *PostPolicy) SetBucket(bucketName string) error

+ func (p *PostPolicy) SetContentLengthRange(min, max int64) error

+ func (p *PostPolicy) SetContentType(contentType string) error

+ func (p *PostPolicy) SetExpires(t time.Time) error

+ func (p *PostPolicy) SetKey(key string) error

+ func (p *PostPolicy) SetKeyStartsWith(keyStartsWith string) error

+ func (p PostPolicy) String() string

+ type SignatureType int

+ const Latest

+ const SignatureV2

+ const SignatureV4

v0

v0.2.0

Jul 17, 2015

Changes in this version

+ const LibraryName

+ const LibraryVersion

+ type API interface

+ func New(config Config) (API, error)

+ type BucketACL string

+ func (b BucketACL) String() string

+ type BucketAPI interface

+ BucketExists func(bucket string) error

+ DropAllIncompleteUploads func(bucket string) <-chan error

+ GetBucketACL func(bucket string) (BucketACL, error)

+ ListBuckets func() <-chan BucketStatCh

+ ListObjects func(bucket, prefix string, recursive bool) <-chan ObjectStatCh

+ MakeBucket func(bucket string, cannedACL BucketACL) error

+ RemoveBucket func(bucket string) error

+ SetBucketACL func(bucket string, cannedACL BucketACL) error

+ type BucketStat struct

+ CreationDate time.Time

+ Name string

+ type BucketStatCh struct

+ Err error

+ Stat BucketStat

+ type Config struct

+ AcceptType string

+ AccessKeyID string

+ Endpoint string

+ Region string

+ SecretAccessKey string

+ Transport http.RoundTripper

+ func (c *Config) SetUserAgent(name string, version string, comments ...string)

+ type ErrorResponse struct

+ Code string

+ HostID string

+ Message string

+ RequestID string

+ Resource string

+ XMLName xml.Name

+ func ToErrorResponse(err error) *ErrorResponse

+ func (e ErrorResponse) Error() string

+ func (e ErrorResponse) ToJSON() string

+ func (e ErrorResponse) ToXML() string

+ type ObjectAPI interface

+ DropIncompleteUploads func(bucket, object string) <-chan error

+ GetObject func(bucket, object string) (io.ReadCloser, ObjectStat, error)

+ GetPartialObject func(bucket, object string, offset, length int64) (io.ReadCloser, ObjectStat, error)

+ PutObject func(bucket, object, contentType string, size int64, data io.Reader) error

+ RemoveObject func(bucket, object string) error

+ StatObject func(bucket, object string) (ObjectStat, error)

+ type ObjectStat struct

+ ContentType string

+ ETag string

+ Key string

+ LastModified time.Time

+ Owner struct{ ... }

+ Size int64

+ StorageClass string

+ type ObjectStatCh struct

+ Err error

+ Stat ObjectStat

Incompatible versions in this module

v3.0.2+incompatible

Sep 1, 2017

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL