GetObject - AWS Elemental MediaStore

GetObject

Downloads the object at the specified path. If the object’s upload availability is set to streaming, AWS Elemental MediaStore downloads the object even if it’s still uploading the object.

When an end user or a content delivery network (CDN) like Amazon CloudFront retrieves an object from MediaStore, the service returns HTTP headers that affect the caching behavior of the object. To learn more about these headers, see MediaStore's interaction with HTTP caches in the AWS Elemental MediaStore User Guide.

Request Syntax

GET /Path+ HTTP/1.1 Range: Range

URI Request Parameters

The request uses the following URI parameters.

Path

The path (including the file name) where the object is stored in the container. Format: <folder name>/<folder name>/<file name>

For example, to upload the file mlaw.avi to the folder path premium\canada in the container movies, enter the path premium/canada/mlaw.avi.

Do not include the container name in this path.

If the path includes any folders that don't exist yet, the service creates them. For example, suppose you have an existing premium/usa subfolder. If you specify premium/canada, the service creates a canada subfolder in the premium folder. You then have two subfolders, usa and canada, in the premium folder.

There is no correlation between the path to the source and the path (folders) in the container in AWS Elemental MediaStore.

For more information about folders and how they exist in a container, see the AWS Elemental MediaStore User Guide.

The file name is the name that is assigned to the file that you upload. The file can have the same name inside and outside of AWS Elemental MediaStore, or it can have the same name. The file name can include or omit an extension.

Length Constraints: Minimum length of 1. Maximum length of 900.

Pattern: (?:[A-Za-z0-9_=:\.\-\~]+/){0,10}[A-Za-z0-9_=:\.\-\~]+

Required: Yes

Range

The range bytes of an object to retrieve. For more information about the Range header, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35. AWS Elemental MediaStore ignores this header for partially uploaded objects that have streaming upload availability.

Pattern: ^bytes=(?:\d+\-\d*|\d*\-\d+)$

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 StatusCode Cache-Control: CacheControl Content-Range: ContentRange Content-Length: ContentLength Content-Type: ContentType ETag: ETag Last-Modified: LastModified Body

Response Elements

If the action is successful, the service sends back the following HTTP response.

StatusCode

The HTML status code of the request. Status codes ranging from 200 to 299 indicate success. All other status codes indicate the type of error that occurred.

The response returns the following HTTP headers.

CacheControl

An optional CacheControl header that allows the caller to control the object's cache behavior. Headers can be passed in as specified in the HTTP spec at https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.

Headers with a custom user-defined value are also accepted.

ContentLength

The length of the object in bytes.

Valid Range: Minimum value of 0.

ContentRange

The range of bytes to retrieve.

Pattern: ^bytes=\d+\-\d+/\d+$

ContentType

The content type of the object.

Pattern: ^[\w\-\/\.\+]{1,255}$

ETag

The ETag that represents a unique instance of the object.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [0-9A-Fa-f]+

LastModified

The date and time that the object was last modified.

The response returns the following as the HTTP body.

Body

The bytes of the object.

Errors

For information about the errors that are common to all actions, see Common Errors.

ContainerNotFoundException

The specified container was not found for the specified account.

HTTP Status Code: 404

InternalServerError

The service is temporarily unavailable.

HTTP Status Code: 500

ObjectNotFoundException

Could not perform an operation on an object that does not exist.

HTTP Status Code: 404

RequestedRangeNotSatisfiableException

The requested content range is not valid.

HTTP Status Code: 416

Examples

Example

The following request downloads the file mlaw.avi from the folder premium/canada in the container that is identified by the endpoint that is specified in the Host: header.

GET premium/canada/mlaw.avi Host: aaabbbcccdddee.files.mediastore-us-west-2.com x-amz-Date: 20170323T120000Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20141123/us-west-2/mediastore/aws4_request,SignedHeaders=host;x-amz-date;x-amz-mediastore-version,Signature=9257c16da6b25a715ce900a5b45b03da0447acf430195dcb540091b12966f2a2 Content-Length: 0 x-amz-mediastore-version: 2016-07-11

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: