awsutil

Documentation

Index

• func GetObject(url string) (*http.Response, error)
• func GetObjectRange(url, byteRange string) (*http.Response, error)
• func HeadObject(url string) (*http.Response, error)
• func Int64Value(i *int64) int64
• func ReadFile(path string) ([]byte, error)
• func String(s string) *string
• type Client
  • func NewClient(bucket, key, region, profile string) Client
  • func (c Client) GetObjectRange(byteRange string) (io.ReadCloser, error)

Functions

func GetObject

func GetObject(url string) (*http.Response, error)

GetObject Makes an http GET request using the URL provided. URL should either point to a public obejct or be a signed URL giving the user GET permissions. url: full url path to the object on AWS

func GetObjectRange

func GetObjectRange(url, byteRange string) (*http.Response, error)

GetObjectRange Makes a ranged http GET request using the URL and byteRange provided. URL should either point to a public obejct or be a signed URL giving the user GET permissions. url: full url path to the object on AWS byteRange: the desired range of bytes of a file Should resemble the format for an http header Range. Example: "bytes="0-1000" Example: "bytes="1000-"

func HeadObject

func HeadObject(url string) (*http.Response, error)

HeadObject Makes an http HEAD request using the URL provided. URL should either point to a public obejct or be a signed URL giving the user GET permissions.

func Int64Value

func Int64Value(i *int64) int64

func ReadFile

func ReadFile(path string) ([]byte, error)

ReadFile Expects the url to point to a valid ngc file. Uses the aws-sdk to read the file, assuming that this file will not be publicly accessible and will need to utilize aws credentials on the machine.

func String

func String(s string) *string

Types

type Client

type Client struct {
	Bucket  string
	Key     string
	Region  string
	Profile string
}

Client This strut provides a clean interface to making a requester pays type of request to the AWS API. Instead of having to construct the AWS configuration, client, session, and ObjectInput, one can simply provide the most basic fields and request an ObjectRange.

func NewClient

func NewClient(bucket, key, region, profile string) Client

NewClient This function should be used to create a Client to avoid missing required fields.

func (Client) GetObjectRange

func (c Client) GetObjectRange(byteRange string) (io.ReadCloser, error)

GetObjectRange Fetches the range of bytes from the file located at the destination on AWS derived from the Client's Bucket and Key fields.