Documentation ¶
Index ¶
- Constants
- Variables
- type ACL
- type Bucket
- func (b *Bucket) Del(path string) error
- func (b *Bucket) DelBucket() (err error)
- func (b *Bucket) DelMulti(objects Delete) error
- func (b *Bucket) Exists(path string) (exists bool, err error)
- func (b *Bucket) Get(path string) (data []byte, err error)
- func (b *Bucket) GetBucketContents() (*map[string]Key, error)
- func (b *Bucket) GetReader(path string) (rc io.ReadCloser, err error)
- func (b *Bucket) GetResponse(path string) (resp *http.Response, err error)
- func (b *Bucket) GetResponseWithHeaders(path string, headers map[string][]string) (resp *http.Response, err error)
- func (b *Bucket) Head(path string, headers map[string][]string) (*http.Response, error)
- func (b *Bucket) InitMulti(key string, contType string, perm ACL) (*Multi, error)
- func (b *Bucket) List(prefix, delim, marker string, max int) (result *ListResp, err error)
- func (b *Bucket) ListMulti(prefix, delim string) (multis []*Multi, prefixes []string, err error)
- func (b *Bucket) Multi(key, contType string, perm ACL) (*Multi, error)
- func (b *Bucket) PostFormArgs(path string, expires time.Time, redirect string) (action string, fields map[string]string)
- func (b *Bucket) Put(path string, data []byte, contType string, perm ACL, options Options) error
- func (b *Bucket) PutBucket(perm ACL) error
- func (b *Bucket) PutBucketSubresource(subresource string, r io.Reader, length int64) error
- func (b *Bucket) PutBucketWebsite(configuration WebsiteConfiguration) error
- func (b *Bucket) PutCopy(path string, perm ACL, options CopyOptions, source string) (*CopyObjectResult, error)
- func (b *Bucket) PutHeader(path string, data []byte, customHeaders map[string][]string, perm ACL) error
- func (b *Bucket) PutReader(path string, r io.Reader, length int64, contType string, perm ACL, ...) error
- func (b *Bucket) PutReaderHeader(path string, r io.Reader, length int64, customHeaders map[string][]string, ...) error
- func (b *Bucket) SignedURL(path string, expires time.Time) string
- func (b *Bucket) URL(path string) string
- func (b *Bucket) UploadSignedURL(path, method, content_type string, expires time.Time) string
- func (b *Bucket) Versions(prefix, delim, keyMarker string, versionIdMarker string, max int) (result *VersionsResp, err error)
- type CopyObjectResult
- type CopyOptions
- type Delete
- type Error
- type Key
- type ListResp
- type Multi
- type Object
- type Options
- type Owner
- type Part
- type ReaderAtSeeker
- type RoutingRule
- type S3
- type Version
- type VersionsResp
- type WebsiteConfiguration
Constants ¶
Variables ¶
var DefaultAttemptStrategy = aws.AttemptStrategy{ Min: 5, Total: 5 * time.Second, Delay: 200 * time.Millisecond, }
DefaultAttemptStrategy is the default AttemptStrategy used by S3 objects created by New.
Functions ¶
This section is empty.
Types ¶
type Bucket ¶
The Bucket type encapsulates operations with an S3 bucket.
func (*Bucket) DelBucket ¶
DelBucket removes an existing S3 bucket. All objects in the bucket must be removed before the bucket itself can be removed.
See http://goo.gl/GoBrY for details.
func (*Bucket) DelMulti ¶
DelMulti removes up to 1000 objects from the S3 bucket.
See http://goo.gl/jx6cWK for details.
func (*Bucket) Exists ¶
Exists checks whether or not an object exists on an S3 bucket using a HEAD request.
func (*Bucket) Get ¶
Get retrieves an object from an S3 bucket.
See http://goo.gl/isCO7 for details.
func (*Bucket) GetBucketContents ¶
Returns a mapping of all key names in this bucket to Key objects
func (*Bucket) GetReader ¶
func (b *Bucket) GetReader(path string) (rc io.ReadCloser, err error)
GetReader retrieves an object from an S3 bucket, returning the body of the HTTP response. It is the caller's responsibility to call Close on rc when finished reading.
func (*Bucket) GetResponse ¶
GetResponse retrieves an object from an S3 bucket, returning the HTTP response. It is the caller's responsibility to call Close on rc when finished reading
func (*Bucket) GetResponseWithHeaders ¶
func (b *Bucket) GetResponseWithHeaders(path string, headers map[string][]string) (resp *http.Response, err error)
GetReaderWithHeaders retrieves an object from an S3 bucket Accepts custom headers to be sent as the second parameter returning the body of the HTTP response. It is the caller's responsibility to call Close on rc when finished reading
func (*Bucket) Head ¶
Head HEADs an object in the S3 bucket, returns the response with no body see http://bit.ly/17K1ylI
func (*Bucket) InitMulti ¶
InitMulti initializes a new multipart upload at the provided key inside b and returns a value for manipulating it.
See http://goo.gl/XP8kL for details.
func (*Bucket) List ¶
List returns information about objects in an S3 bucket.
The prefix parameter limits the response to keys that begin with the specified prefix.
The delim parameter causes the response to group all of the keys that share a common prefix up to the next delimiter in a single entry within the CommonPrefixes field. You can use delimiters to separate a bucket into different groupings of keys, similar to how folders would work.
The marker parameter specifies the key to start with when listing objects in a bucket. Amazon S3 lists objects in alphabetical order and will return keys alphabetically greater than the marker.
The max parameter specifies how many keys + common prefixes to return in the response. The default is 1000.
For example, given these keys in a bucket:
index.html index2.html photos/2006/January/sample.jpg photos/2006/February/sample2.jpg photos/2006/February/sample3.jpg photos/2006/February/sample4.jpg
Listing this bucket with delimiter set to "/" would yield the following result:
&ListResp{ Name: "sample-bucket", MaxKeys: 1000, Delimiter: "/", Contents: []Key{ {Key: "index.html", "index2.html"}, }, CommonPrefixes: []string{ "photos/", }, }
Listing the same bucket with delimiter set to "/" and prefix set to "photos/2006/" would yield the following result:
&ListResp{ Name: "sample-bucket", MaxKeys: 1000, Delimiter: "/", Prefix: "photos/2006/", CommonPrefixes: []string{ "photos/2006/February/", "photos/2006/January/", }, }
See http://goo.gl/YjQTc for details.
func (*Bucket) ListMulti ¶
ListMulti returns the list of unfinished multipart uploads in b.
The prefix parameter limits the response to keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys (to get the feeling of folders, for example).
The delim parameter causes the response to group all of the keys that share a common prefix up to the next delimiter in a single entry within the CommonPrefixes field. You can use delimiters to separate a bucket into different groupings of keys, similar to how folders would work.
See http://goo.gl/ePioY for details.
func (*Bucket) Multi ¶
Multi returns a multipart upload handler for the provided key inside b. If a multipart upload exists for key, it is returned, otherwise a new multipart upload is initiated with contType and perm.
func (*Bucket) PostFormArgs ¶
func (b *Bucket) PostFormArgs(path string, expires time.Time, redirect string) (action string, fields map[string]string)
PostFormArgs returns the action and input fields needed to allow anonymous uploads to a bucket within the expiration limit
func (*Bucket) PutBucketSubresource ¶
func (*Bucket) PutBucketWebsite ¶
func (b *Bucket) PutBucketWebsite(configuration WebsiteConfiguration) error
func (*Bucket) PutCopy ¶
func (b *Bucket) PutCopy(path string, perm ACL, options CopyOptions, source string) (*CopyObjectResult, error)
PutCopy puts a copy of an object given by the key path into bucket b using b.Path as the target key
func (*Bucket) PutHeader ¶
func (b *Bucket) PutHeader(path string, data []byte, customHeaders map[string][]string, perm ACL) error
PutHeader - like Put, inserts an object into the S3 bucket. Instead of Content-Type string, pass in custom headers to override defaults.
func (*Bucket) PutReader ¶
func (b *Bucket) PutReader(path string, r io.Reader, length int64, contType string, perm ACL, options Options) error
PutReader inserts an object into the S3 bucket by consuming data from r until EOF.
func (*Bucket) PutReaderHeader ¶
func (b *Bucket) PutReaderHeader(path string, r io.Reader, length int64, customHeaders map[string][]string, perm ACL) error
PutReaderHeader - like PutReader, inserts an object into S3 from a reader. Instead of Content-Type string, pass in custom headers to override defaults.
func (*Bucket) SignedURL ¶
SignedURL returns a signed URL that allows anyone holding the URL to retrieve the object at path. The signature is valid until expires.
func (*Bucket) URL ¶
URL returns a non-signed URL that allows retriving the object at path. It only works if the object is publicly readable (see SignedURL).
func (*Bucket) UploadSignedURL ¶
UploadSignedURL returns a signed URL that allows anyone holding the URL to upload the object at path. The signature is valid until expires. contenttype is a string like image/png path is the resource name in s3 terminalogy like images/ali.png [obviously exclusing the bucket name itself]
type CopyObjectResult ¶
CopyObjectResult is the output from a Copy request
type CopyOptions ¶
type Error ¶
type Error struct { StatusCode int // HTTP status code (200, 403, ...) Code string // EC2 error code ("UnsupportedOperation", ...) Message string // The human-oriented error message BucketName string RequestId string HostId string }
Error represents an error in an operation with S3.
type Key ¶
type Key struct { Key string LastModified string Size int64 // ETag gives the hex-encoded MD5 sum of the contents, // surrounded with double-quotes. ETag string StorageClass string Owner Owner }
The Key type represents an item stored in an S3 bucket.
type ListResp ¶
type ListResp struct { Name string Prefix string Delimiter string Marker string NextMarker string MaxKeys int // IsTruncated is true if the results have been truncated because // there are more keys and prefixes than can fit in MaxKeys. // N.B. this is the opposite sense to that documented (incorrectly) in // http://goo.gl/YjQTc IsTruncated bool Contents []Key CommonPrefixes []string `xml:">Prefix"` }
The ListResp type holds the results of a List bucket operation.
type Multi ¶
Multi represents an unfinished multipart upload.
Multipart uploads allow sending big objects in smaller chunks. After all parts have been sent, the upload must be explicitly completed by calling Complete with the list of parts.
See http://goo.gl/vJfTG for an overview of multipart uploads.
func (*Multi) Abort ¶
Abort deletes an unifinished multipart upload and any previously uploaded parts for it.
After a multipart upload is aborted, no additional parts can be uploaded using it. However, if any part uploads are currently in progress, those part uploads might or might not succeed. As a result, it might be necessary to abort a given multipart upload multiple times in order to completely free all storage consumed by all parts.
NOTE: If the described scenario happens to you, please report back to the goamz authors with details. In the future such retrying should be handled internally, but it's not clear what happens precisely (Is an error returned? Is the issue completely undetectable?).
See http://goo.gl/dnyJw for details.
func (*Multi) Complete ¶
Complete assembles the given previously uploaded parts into the final object. This operation may take several minutes.
The complete call to AMZ may still fail after returning HTTP 200, so even though it's unusued, the body of the reply must be demarshalled and checked to see whether or not the complete succeeded.
See http://goo.gl/2Z7Tw for details.
func (*Multi) ListParts ¶
ListParts returns the list of previously uploaded parts in m, ordered by part number.
See http://goo.gl/ePioY for details.
func (*Multi) PutAll ¶
func (m *Multi) PutAll(r ReaderAtSeeker, partSize int64) ([]Part, error)
PutAll sends all of r via a multipart upload with parts no larger than partSize bytes, which must be set to at least 5MB. Parts previously uploaded are either reused if their checksum and size match the new part, or otherwise overwritten with the new content. PutAll returns all the parts of m (reused or not).
func (*Multi) PutPart ¶
PutPart sends part n of the multipart upload, reading all the content from r. Each part, except for the last one, must be at least 5MB in size.
See http://goo.gl/pqZer for details.
type Options ¶
type Options struct { SSE bool Meta map[string][]string ContentEncoding string CacheControl string RedirectLocation string ContentMD5 string }
Fold options into an Options struct
type ReaderAtSeeker ¶
type ReaderAtSeeker interface { io.ReaderAt io.ReadSeeker }
type RoutingRule ¶
type S3 ¶
type S3 struct { aws.Auth aws.Region // ConnectTimeout is the maximum time a request attempt will // wait for a successful connection to be made. // // A value of zero means no timeout. ConnectTimeout time.Duration // ReadTimeout is the maximum time a request attempt will wait // for an individual read to complete. // // A value of zero means no timeout. ReadTimeout time.Duration // WriteTimeout is the maximum time a request attempt will // wait for an individual write to complete. // // A value of zero means no timeout. WriteTimeout time.Duration // RequestTimeout is the maximum time a request attempt can // take before operations return a timeout error. // // This includes connection time, any redirects, and reading // the response body. The timer remains running after the request // is made so it can interrupt reading of the response data. // // A Timeout of zero means no timeout. RequestTimeout time.Duration // AttemptStrategy is the attempt strategy used for requests. aws.AttemptStrategy // contains filtered or unexported fields }
The S3 type encapsulates operations with an S3 region.
type Version ¶
type Version struct { Key string VersionId string IsLatest bool LastModified string // ETag gives the hex-encoded MD5 sum of the contents, // surrounded with double-quotes. ETag string Size int64 Owner Owner StorageClass string }
The Version type represents an object version stored in an S3 bucket.
type VersionsResp ¶
type VersionsResp struct { Name string Prefix string KeyMarker string VersionIdMarker string MaxKeys int Delimiter string IsTruncated bool Versions []Version CommonPrefixes []string `xml:">Prefix"` }
The VersionsResp type holds the results of a list bucket Versions operation.
type WebsiteConfiguration ¶
type WebsiteConfiguration struct { XMLName xml.Name `xml:"http://s3.amazonaws.com/doc/2006-03-01/ WebsiteConfiguration"` IndexDocumentSuffix string `xml:"IndexDocument>Suffix"` ErrorDocumentKey string `xml:"ErrorDocument>Key"` RoutingRules *[]RoutingRule `xml:"RoutingRules>RoutingRule,omitempty"` }