AWS Elemental MediaStore
API Reference (API Version 2017-09-01)

DescribeObject

Gets the headers for an object at the specified path.

Request Syntax

HEAD /Path+ HTTP/1.1

URI Request Parameters

The request requires 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>

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

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

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 ETag: ETag Content-Type: ContentType Content-Length: ContentLength Cache-Control: CacheControl Last-Modified: LastModified

Response Elements

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

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 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.

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.

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

Example

The following request gets the headers for 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.

HEAD 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: