s3err

type APIError ¶

type APIError struct {
	Code           string
	Description    string
	HTTPStatusCode int
}

APIError structure

func GetAPIError(code ErrorCode) APIError

func GetChecksumBadDigestErr(algo types.ChecksumAlgorithm) APIError

func GetChecksumSchemaMismatchErr(algo types.ChecksumAlgorithm, t types.ChecksumType) APIError

func GetChecksumTypeMismatchErr(expected, actual types.ChecksumAlgorithm) APIError

func GetChecksumTypeMismatchOnMpErr(t types.ChecksumType) APIError

func GetCopySourceObjectTooLargeErr(limit int64) APIError

func GetIncorrectMpObjectSizeErr(expected, actual int64) APIError

func GetInvalidCORSHeaderErr(header string) APIError

func GetInvalidCORSMethodErr(method string) APIError

func GetInvalidCORSRequestHeaderErr(header string) APIError

func GetInvalidChecksumHeaderErr(header string) APIError

func GetInvalidMpObjectSizeErr(val string) APIError

func GetInvalidTrailingChecksumHeaderErr(header string) APIError

func GetMultipleWildcardCORSOriginErr(origin string) APIError

func GetNegatvieMpObjectSizeErr(val int64) APIError

func GetUnsopportedCORSMethodErr(method string) APIError

func (e APIError) BaseError() APIError

func (A APIError) Error() string

func (e APIError) StatusCode() int

func (e APIError) XMLBody(requestID, hostID string) []byte

type AccessForbiddenError ¶ added in v1.5.0

type AccessForbiddenError struct {
	APIError
	Method       string
	ResourceType ResourceType
}

AccessForbiddenError is returned when a CORS request is not allowed. Produces <Method> and <ResourceType> fields in the XML response.

func GetAccessForbiddenErr(code ErrorCode, method string, resourceType ResourceType) AccessForbiddenError

func (e AccessForbiddenError) Is(target error) bool

func (e AccessForbiddenError) XMLBody(requestID, hostID string) []byte

type BadDigestError ¶ added in v1.5.0

type BadDigestError struct {
	APIError
	CalculatedDigest string
	ExpectedDigest   string
}

BadDigestError is returned when the Content-MD5 does not match the received data. Produces <CalculatedDigest> and <ExpectedDigest> fields in the XML response.

func GetBadDigestErr(calculated, expected string) BadDigestError

func (e BadDigestError) Is(target error) bool

func (e BadDigestError) XMLBody(requestID, hostID string) []byte

type BucketError ¶ added in v1.5.0

type BucketError struct {
	APIError
	BucketName string
}

BucketError is returned for errors that include the bucket name. Produces a <BucketName> field in the XML response.

func GetBucketErr(code ErrorCode, bucket string) BucketError

func (e BucketError) Is(target error) bool

func (e BucketError) XMLBody(requestID, hostID string) []byte

type Condition ¶ added in v1.5.0

type Condition string

const (
	ConditionIfMatch              Condition = "If-Match"
	ConditionIfNoneMatch          Condition = "If-None-Match"
	ConditionIfUnmodifiedSince    Condition = "If-Unmodified-Since"
	ConditionIfMatchSize          Condition = "If-Match-Size"
	ConditionIfMatchInitiatedTime Condition = "If-Match-Initiated-Time"
	ConditionIfMatchLastModTime   Condition = "If-Match-Last-Mod-Time"
	ConditionPostBucket           Condition = "Bucket POST must be of the enclosure-type multipart/form-data"
)

type ContentSHA256MismatchError ¶ added in v1.5.0

type ContentSHA256MismatchError struct {
	APIError
	ClientComputedContentSHA256 string
	S3ComputedContentSHA256     string
}

ContentSHA256MismatchError is returned when the x-amz-content-sha256 header does not match the computed hash of the request payload. Produces <ClientComputedContentSHA256> and <S3ComputedContentSHA256> fields.

func GetContentSHA256MismatchErr(clientHash, s3Hash string) ContentSHA256MismatchError

func (e ContentSHA256MismatchError) Is(target error) bool

func (e ContentSHA256MismatchError) XMLBody(requestID, hostID string) []byte

type EntityTooLargeError ¶ added in v1.5.0

type EntityTooLargeError struct {
	APIError
	ProposedSize   int64
	MaxSizeAllowed int64
}

EntityTooLargeError is returned when the proposed upload exceeds the maximum allowed size. Produces <ProposedSize> and <MaxSizeAllowed> fields in the XML response.

func GetEntityTooLargeErr(proposedSize, maxSizeAllowed int64) EntityTooLargeError

func (e EntityTooLargeError) Is(target error) bool

func (e EntityTooLargeError) XMLBody(requestID, hostID string) []byte

type EntityTooSmallError ¶ added in v1.5.0

type EntityTooSmallError struct {
	APIError
	ProposedSize   int64
	MinSizeAllowed int64
}

EntityTooSmallError is returned when the proposed upload is smaller than the minimum allowed size. Produces <ProposedSize> and <MinSizeAllowed> fields in the XML response.

func GetEntityTooSmallErr(proposedSize, minSizeAllowed int64) EntityTooSmallError

func (e EntityTooSmallError) Is(target error) bool

func (e EntityTooSmallError) XMLBody(requestID, hostID string) []byte

type ErrorCode ¶

type ErrorCode int

ErrorCode type of error status.

const (
	ErrNone ErrorCode = iota
	ErrAccessDenied
	ErrAnonymousRequest
	ErrAnonymousCreateMp
	ErrAnonymousCopyObject
	ErrAnonymousPutBucketOwnership
	ErrAnonymousGetBucketOwnership
	ErrAnonymousResponseHeaders
	ErrMethodNotAllowed
	ErrBucketNotEmpty
	ErrVersionedBucketNotEmpty
	ErrBucketAlreadyExists
	ErrBucketAlreadyOwnedByYou
	ErrNoSuchBucket
	ErrNoSuchKey
	ErrNoSuchUpload
	ErrInvalidBucketName
	ErrInvalidDigest
	ErrBadDigest
	ErrInvalidPart
	ErrInvalidPartNumberRange
	ErrRangeAndPartNumber
	ErrInvalidPartOrder
	ErrInternalError
	ErrNonEmptyRequestBody
	ErrIncompleteBody
	ErrInvalidCopyDest
	ErrInvalidTagKey
	ErrInvalidTagValue
	ErrDuplicateTagKey
	ErrBucketTaggingLimited
	ErrObjectTaggingLimited
	ErrCannotParseHTTPRequest
	ErrMalformedPOSTRequest
	ErrEntityTooSmall
	ErrEntityTooLarge
	ErrMalformedXML
	ErrMalformedCredentialDate
	ErrExpiredPresignRequest
	ErrSignatureDoesNotMatch
	ErrContentSHA256Mismatch
	ErrInvalidSHA256PayloadUsage
	ErrUnsupportedAnonymousSignedStreaming
	ErrMissingContentLength
	ErrContentLengthMismatch
	ErrInvalidAccessKeyID
	ErrRequestNotReadyYet
	ErrMissingDateHeader
	ErrGetUploadsWithKey
	ErrVersionsWithKey
	ErrInvalidRequest
	ErrAuthNotSetup
	ErrNotImplemented
	ErrPreconditionFailed
	ErrInvalidObjectState
	ErrInvalidRange
	ErrInvalidURI
	ErrObjectLockConfigurationNotFound
	ErrNoSuchObjectLockConfiguration
	ErrMissingObjectLockConfiguration
	ErrMissingObjectLockConfigurationNoSpaces
	ErrObjectLockConfigurationNotAllowed
	ErrObjectLocked
	ErrNoSuchBucketPolicy
	ErrBucketTaggingNotFound
	ErrObjectAttributesInvalidHeader
	ErrRequestTimeTooSkewed
	ErrInvalidBucketAclWithObjectOwnership
	ErrBothCannedAndHeaderGrants
	ErrOwnershipControlsNotFound
	ErrAclNotSupported
	ErrMalformedACL
	ErrUnexpectedContent
	ErrMissingSecurityHeader
	ErrKeyTooLong
	ErrNoSuchVersion
	ErrSuspendedVersioningNotAllowed
	ErrMissingRequestBody
	ErrMultipleChecksumHeaders
	ErrChecksumSDKAlgoMismatch
	ErrChecksumRequired
	ErrMissingContentSha256
	ErrInvalidChecksumAlgorithm
	ErrChecksumTypeWithAlgo
	ErrInvalidChecksumHeader
	ErrTrailerHeaderNotSupported
	ErrBadRequest
	ErrNoSuchCORSConfiguration
	ErrCORSForbidden
	ErrMissingCORSOrigin
	ErrCORSIsNotEnabled
	ErrNotModified
	ErrInvalidLocationConstraint
	ErrMalformedTrailer
	ErrInvalidChunkSize
	ErrSlowDown
	ErrMetadataTooLarge
	ErrUnsupportedAuthorizationMechanism

	// Non-AWS errors
	ErrExistingObjectIsDirectory
	ErrObjectParentIsFile
	ErrDirectoryObjectContainsData
	ErrDirectoryNotEmpty
	ErrQuotaExceeded
	ErrVersioningNotConfigured
	ErrACLsDisabled
	ErrNoSpaceLeftOnDevice

	// Admin api errors
	ErrAdminAccessDenied
	ErrAdminUserNotFound
	ErrAdminUserExists
	ErrAdminInvalidUserRole
	ErrAdminMissingUserAcess
	ErrAdminMethodNotSupported
	ErrAdminEmptyBucketOwnerHeader
)

type ExpiredPresignedURLError ¶ added in v1.5.0

type ExpiredPresignedURLError struct {
	APIError
	ServerTime  string
	XAmzExpires int
	Expires     string
}

ExpiredPresignedURLError is returned when the presigned url is expired Produces <ServerTime>, <X-Amz-Expires> and <Expires> fields in the XML response.

func GetExpiredPresignedURLError(XAmzExpires int, expires, serverTime string) ExpiredPresignedURLError

func (e ExpiredPresignedURLError) Is(target error) bool

func (e ExpiredPresignedURLError) XMLBody(requestID, hostID string) []byte

type HeadersNotSignedError ¶ added in v1.5.0

type HeadersNotSignedError struct {
	APIError
	HeadersNotSigned string
}

HeadersNotSignedError is returned when signature verification receives required signed headers that were omitted from SignedHeaders.

func GetHeadersNotSignedErr(headers []string) HeadersNotSignedError

func (e HeadersNotSignedError) Is(target error) bool

func (e HeadersNotSignedError) XMLBody(requestID, hostID string) []byte

type InvalidAccessKeyIdError ¶ added in v1.5.0

type InvalidAccessKeyIdError struct {
	APIError
	AWSAccessKeyId string
}

InvalidAccessKeyIdError is returned when the provided AWS access key ID does not exist. Produces an <AWSAccessKeyId> field in the XML response.

func GetInvalidAccessKeyIdErr(accessKeyId string) InvalidAccessKeyIdError

func (e InvalidAccessKeyIdError) Is(target error) bool

func (e InvalidAccessKeyIdError) XMLBody(requestID, hostID string) []byte

type InvalidArgErrorCode ¶ added in v1.5.0

type InvalidArgErrorCode int

const (
	InvalidArgMaxBuckets InvalidArgErrorCode = iota
	InvalidArgNegativeMaxKeys
	InvalidArgObjectAttributes
	InvalidArgPartNumber
	InvalidArgCompleteMpPartNumber
	InvalidArgCopySourceRange
	InvalidArgCopySourceBucket
	InvalidArgCopySourceObject
	InvalidArgCopySourceEncoding
	InvalidArgURLEncodedTagging
	InvalidArgAuthHeader
	InvalidArgAuthorizationType
	InvalidArgPOSTFileRequired
	InvalidArgSHA256Payload
	InvalidArgCopySource
	InvalidArgRetainUntilDate
	InvalidArgPastObjectLockRetainDate
	InvalidArgObjectLockRetentionDays
	InvalidArgObjectLockRetentionYears
	InvalidArgMissingObjectLockRetainDate
	InvalidArgMissingObjectLockMode
	InvalidArgLegalHoldStatus
	InvalidArgObjectLockMode
	InvalidArgMetadataDirective
	InvalidArgTaggingDirective
	InvalidArgVersionId
	InvalidArgChecksumPart
	InvalidArgMissingUploadId
	InvalidArgUploadIdMarker
	InvalidArgCannedAcl
	InvalidArgOnlyAws4HmacSha256
	InvalidArgDateHeader
)

type InvalidArgumentError ¶ added in v1.5.0

type InvalidArgumentError struct {
	Description   string
	ArgumentName  string
	ArgumentValue string
}

InvalidArgumentError is returned when a request argument is invalid. Produces <ArgumentName> and <ArgumentValue> fields in the XML response.

func GetInvalidArgExceedingRange(size int64) InvalidArgumentError

func GetInvalidArgMaxLimiter(name, value string) InvalidArgumentError

func GetInvalidArgNegativeMaxLimiter(name, value string) InvalidArgumentError

func GetInvalidArgObjectOwnership(value string) InvalidArgumentError

func GetInvalidArgumentErr(code InvalidArgErrorCode, value string) InvalidArgumentError

func (e InvalidArgumentError) BaseError() APIError

func (e InvalidArgumentError) Error() string

func (e InvalidArgumentError) StatusCode() int

func (e InvalidArgumentError) XMLBody(requestID, hostID string) []byte

type InvalidChunkSizeError ¶ added in v1.5.0

type InvalidChunkSizeError struct {
	APIError
	Chunk        int
	BadChunkSize int64
}

InvalidChunkSizeError is returned when a chunk size in a streaming upload is invalid. Produces <Chunk> and <BadChunkSize> fields in the XML response.

func GetInvalidChunkSizeErr(chunk int, badChunkSize int64) InvalidChunkSizeError

func (e InvalidChunkSizeError) Is(target error) bool

func (e InvalidChunkSizeError) XMLBody(requestID, hostID string) []byte

type InvalidDigestError ¶ added in v1.5.0

type InvalidDigestError struct {
	APIError
	ContentMD5 string
}

InvalidDigestError is returned when the Content-MD5 header value is invalid. Produces a <Content-MD5> field in the XML response.

func GetInvalidDigestErr(contentMD5 string) InvalidDigestError

func (e InvalidDigestError) Is(target error) bool

func (e InvalidDigestError) XMLBody(requestID, hostID string) []byte

type InvalidLocationConstraintError ¶ added in v1.5.0

type InvalidLocationConstraintError struct {
	APIError
	LocationConstraint string
}

InvalidLocationConstraintError is returned when an invalid location constraint is provided. Produces a <LocationConstraint> field in the XML response.

func GetInvalidLocationConstraintErr(constraint string) InvalidLocationConstraintError

func (e InvalidLocationConstraintError) Is(target error) bool

func (e InvalidLocationConstraintError) XMLBody(requestID, hostID string) []byte

type InvalidPartError ¶ added in v1.5.0

type InvalidPartError struct {
	APIError
	UploadId   string
	PartNumber int32
	ETag       string
}

InvalidPartError is returned when one or more specified parts cannot be found. Produces <UploadId>, <PartNumber>, and <ETag> fields in the XML response.

func GetInvalidPartErr(uploadId string, partNumber int32, etag string) InvalidPartError

func (e InvalidPartError) Is(target error) bool

func (e InvalidPartError) XMLBody(requestID, hostID string) []byte

type InvalidPartNumberRangeError ¶ added in v1.5.0

type InvalidPartNumberRangeError struct {
	APIError
	ActualPartCount     int32
	PartNumberRequested int32
}

InvalidPartNumberRangeError is returned when the requested part number exceeds the number of parts available for the object. Produces <ActualPartCount> and <PartNumberRequested> fields in the XML response.

func GetInvalidPartNumberRangeErr(actualPartCount, partNumberRequested int32) InvalidPartNumberRangeError

func (e InvalidPartNumberRangeError) Is(target error) bool

func (e InvalidPartNumberRangeError) XMLBody(requestID, hostID string) []byte

type InvalidRangeError ¶ added in v1.5.0

type InvalidRangeError struct {
	APIError
	RangeRequested   string
	ActualObjectSize int64
}

InvalidRangeError is returned when the requested byte range cannot be satisfied. Produces <RangeRequested> and <ActualObjectSize> fields in the XML response.

func GetInvalidRangeErr(rangeRequested string, actualObjectSize int64) InvalidRangeError

func (e InvalidRangeError) Is(target error) bool

func (e InvalidRangeError) XMLBody(requestID, hostID string) []byte

type InvalidTagError ¶ added in v1.5.0

type InvalidTagError struct {
	APIError
	TagKey   string
	TagValue string
}

InvalidTagError is returned when a tag key or value is invalid. Produces <TagKey> and optionally <TagValue> fields in the XML response.

func GetInvalidTagErr(code ErrorCode, tagKey, tagValue string) InvalidTagError

func (e InvalidTagError) Is(target error) bool

func (e InvalidTagError) XMLBody(requestID, hostID string) []byte

type KeyTooLongError ¶ added in v1.5.0

type KeyTooLongError struct {
	APIError
	Size           int64
	MaxSizeAllowed int64
}

KeyTooLongError is returned when the object key exceeds the maximum allowed length. Produces <Size> and <MaxSizeAllowed> fields in the XML response.

func GetKeyTooLongErr(size, maxSizeAllowed int64) KeyTooLongError

func (e KeyTooLongError) Is(target error) bool

func (e KeyTooLongError) XMLBody(requestID, hostID string) []byte

type MalformedAuthError ¶ added in v1.5.0

type MalformedAuthError struct {
	APIError
	Region string
}

MalformedAuthError is returned when a Signature V4 authorization header is malformed. Produces a <Region> field in the XML response when the expected gateway region is known.

func (e MalformedAuthError) Is(target error) bool

func (e MalformedAuthError) XMLBody(requestID, hostID string) []byte

type MetadataTooLargeError ¶ added in v1.5.0

type MetadataTooLargeError struct {
	APIError
	Size           int
	MaxSizeAllowed int
}

MetadataTooLargeError is returned when the request metadata headers exceed the allowed size. Produces <Size> and <MaxSizeAllowed> fields in the XML response.

func GetMetadataTooLargeErr(size, maxSizeAllowed int) MetadataTooLargeError

func (e MetadataTooLargeError) Is(target error) bool

func (e MetadataTooLargeError) XMLBody(requestID, hostID string) []byte

type MethodNotAllowedError ¶ added in v1.5.0

type MethodNotAllowedError struct {
	APIError
	Method         string
	ResourceType   ResourceType
	AllowedMethods []string
}

MethodNotAllowedError is returned when an HTTP method is not permitted on a resource. Produces <Method> and <ResourceType> fields in the XML response. AllowedMethods is used to populate the HTTP Allow: response header.

func GetMethodNotAllowedErr(method string, resourceType ResourceType, allowed []string) MethodNotAllowedError

func (mna *MethodNotAllowedError) AllowedMethodsString() string

func (e MethodNotAllowedError) Is(target error) bool

func (e MethodNotAllowedError) XMLBody(requestID, hostID string) []byte

type NmpAdditionalMessage ¶ added in v1.5.0

type NmpAdditionalMessage string

const (
	NmpAdditionalMessageIfNoneMatch         NmpAdditionalMessage = "We don\\'t accept the provided value of If-None-Match header for this API"
	NmpAdditionalMessageMultipleCondHeaders NmpAdditionalMessage = "Multiple conditional request headers present in the request"
)

type NoSuchUploadError ¶ added in v1.5.0

type NoSuchUploadError struct {
	APIError
	UploadId string
}

NoSuchUploadError is returned when the specified multipart upload does not exist. Produces an <UploadId> field in the XML response.

func GetNoSuchUploadErr(uploadId string) NoSuchUploadError

func (e NoSuchUploadError) Is(target error) bool

func (e NoSuchUploadError) XMLBody(requestID, hostID string) []byte

type NoSuchVersionError ¶ added in v1.5.0

type NoSuchVersionError struct {
	APIError
	Key       string
	VersionId string
}

NoSuchVersionError is returned when the specified version does not exist. Produces <Key> and <VersionId> fields in the XML response.

func GetNoSuchVersionErr(key, versionId string) NoSuchVersionError

func (e NoSuchVersionError) Is(target error) bool

func (e NoSuchVersionError) XMLBody(requestID, hostID string) []byte

type NotImplementedError ¶ added in v1.5.0

type NotImplementedError struct {
	APIError
	Header            string
	AdditionalMessage NmpAdditionalMessage
}

NotImplementedError is returned when a header implies unsupported functionality. Produces <Header> and <additionalMessage> fields in the XML response.

func GetNotImplementedErr(header string, additionalMessage NmpAdditionalMessage) NotImplementedError

func (e NotImplementedError) Is(target error) bool

func (e NotImplementedError) XMLBody(requestID, hostID string) []byte

type PreconditionFailedError ¶ added in v1.5.0

type PreconditionFailedError struct {
	APIError
	Condition Condition
}

PreconditionFailedError is returned when a conditional request precondition is not met. Produces a <Condition> field in the XML response.

func GetPreconditionFailedErr(condition Condition) PreconditionFailedError

func (e PreconditionFailedError) Is(target error) bool

func (e PreconditionFailedError) XMLBody(requestID, hostID string) []byte

type RequestTimeTooSkewedError ¶ added in v1.5.0

type RequestTimeTooSkewedError struct {
	APIError
	RequestTime                string
	ServerTime                 string
	MaxAllowedSkewMilliseconds int
}

RequestTimeTooSkewedError is returned when the request timestamp is too far from server time. Produces <RequestTime>, <ServerTime>, and <MaxAllowedSkewMilliseconds> fields.

func GetRequestTimeTooSkewedErr(requestTime, serverTime string, maxAllowedMilliseconds int) RequestTimeTooSkewedError

func (e RequestTimeTooSkewedError) Is(target error) bool

func (e RequestTimeTooSkewedError) XMLBody(requestID, hostID string) []byte

type ResourceType ¶ added in v1.5.0

type ResourceType string

const (
	ResourceTypeBucket       ResourceType = "BUCKET"
	ResourceTypeObject       ResourceType = "OBJECT"
	ResourceTypeService      ResourceType = "SERVICE"
	ResourceTypeBucketPolicy ResourceType = "BUCKETPOLICY"
	ResourceTypeUpload       ResourceType = "UPLOAD"
)

type S3Error ¶ added in v1.5.0

type S3Error interface {
	error
	StatusCode() int
	BaseError() APIError
	XMLBody(requestID, hostID string) []byte
}

S3Error is the interface implemented by all S3 error types. It allows centralized error handling while supporting per-error-type XML fields.

type SignatureDoesNotMatchError ¶ added in v1.5.0

type SignatureDoesNotMatchError struct {
	APIError
	AWSAccessKeyId        string
	StringToSign          string
	SignatureProvided     string
	StringToSignBytes     string
	CanonicalRequest      string
	CanonicalRequestBytes string
}

SignatureDoesNotMatchError is returned when request signature verification fails. Produces diagnostic fields to help callers debug the mismatch.

func GetSignatureDoesNotMatchErr(accessKeyId, stringToSign, signatureProvided, stringToSignBytes, canonicalRequest, canonicalRequestBytes string) SignatureDoesNotMatchError

func (e SignatureDoesNotMatchError) Is(target error) bool

func (e SignatureDoesNotMatchError) XMLBody(requestID, hostID string) []byte