The request does not have a request body.
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 76).
ContainerNotFoundException
DeleteObject
HTTP Status Code: 404
Examples
Example
The following request deletes the file mlaw.avi that is in the folder premium/canada:
DELETE 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:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DescribeObject
DescribeObject
Service: AWS Elemental MediaStore Data Plane Gets the headers for an object at the specified path.
Request Syntax
HEAD /Path+ HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
Path (p. 50)
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_=:\.\-\~]+
Required: Yes
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.
DescribeObject
ContentType (p. 50)
The content type of the object.
Pattern: ^[\w\-\/\.\+]{1,255}$
ETag (p. 50)
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 (p. 50)
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 (p. 76).
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
Examples
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
For more information about using this API in one of the language-specific AWS SDKs, see the following:
DescribeObject
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
GetObject
GetObject
Service: AWS Elemental MediaStore Data Plane
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 (p. 53)
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 (p. 53)
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+)$
GetObject
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 (p. 54)
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 (p. 54)
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 (p. 54)
The length of the object in bytes.
Valid Range: Minimum value of 0.
ContentRange (p. 54)
The range of bytes to retrieve.
Pattern: ^bytes=\d+\-\d+/\d+$
GetObject
LastModified (p. 54)
The date and time that the object was last modified.
The response returns the following as the HTTP body.
Body (p. 54)
The bytes of the object.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 76).
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
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
GetObject
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ListItems
ListItems
Service: AWS Elemental MediaStore Data Plane
Provides a list of metadata entries about folders and objects in the specified folder.
The ListItems response does not include objects that are subject to a transient data rule (objects expire within seconds) in an object lifecycle policy. For more information about rules in object lifecycle policies, see Components of an Object Lifecycle Policy in the AWS Elemental MediaStore User Guide.
Request Syntax
GET /?MaxResults=MaxResults&NextToken=NextToken&Path=Path HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
MaxResults (p. 57)
The maximum number of results to return per API request. For example, you submit a ListItems request with MaxResults set at 500. Although 2,000 items match your request, the service returns no more than the first 500 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value.
If MaxResults is not included in the request, the service defaults to pagination with a maximum of 1,000 results per page.
Valid Range: Minimum value of 1. Maximum value of 1000.
NextToken (p. 57)
The token that identifies which batch of results that you want to see. For example, you submit a ListItems request with MaxResults set at 500. The service returns the first batch of results (up to 500) and a NextToken value. To see the next batch of results, you can submit the ListItems request a second time and specify the NextToken value.
Tokens expire after 15 minutes.
Path (p. 57)
The path in the container from which to retrieve items. Format: <folder name>/<folder name>/<file name>
Length Constraints: Minimum length of 0. 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
Content-type: application/json {
ListItems
"NextToken": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Items (p. 57)
The metadata entries for the folders and objects at the requested path.
Type: Array of Item (p. 72) objects NextToken (p. 57)
The token that can be used in a request to view the next set of results. For example, you submit a ListItems request that matches 2,000 items with MaxResults set at 500. The service returns the first batch of results (up to 500) and a NextToken value that can be used to fetch the next batch of results.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors (p. 76).
ContainerNotFoundException
The specified container was not found for the specified account.
HTTP Status Code: 404 InternalServerError
The service is temporarily unavailable.
ListItems
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
PutObject
PutObject
Service: AWS Elemental MediaStore Data Plane
Uploads an object to the specified path. Object sizes are limited to 25 MB for standard upload availability and 10 MB for streaming upload availability. If the object doesn't fully upload within 30 seconds,
MediaStore cancels the request. This applies to all objects, regardless of whether they are uploaded using standard or streaming upload availability.
Request Syntax
The request uses the following URI parameters.
CacheControl (p. 60)
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.
ContentType (p. 60)
The content type of the object.
Pattern: ^[\w\-\/\.\+]{1,255}$
Path (p. 60)
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
PutObject
Length Constraints: Minimum length of 1. Maximum length of 900.
Pattern: (?:[A-Za-z0-9_=:\.\-\~]+/){0,10}[A-Za-z0-9_=:\.\-\~]+
Required: Yes StorageClass (p. 60)
Indicates the storage class of a Put request. Defaults to high-performance temporal storage class, and objects are persisted into durable storage shortly after being received.
Length Constraints: Minimum length of 1. Maximum length of 16.
Valid Values: STANDARD | TEMPORAL UploadAvailability (p. 60)
Indicates the availability of an object while it is still uploading. If the value is set to streaming, the object is available for downloading after some initial buffering but before the object is uploaded completely. If the value is set to standard, the object is available for downloading only when it is uploaded completely. The default value for this header is standard.
To use this header, you must also set the HTTP Transfer-Encoding header to chunked.
Length Constraints: Minimum length of 1. Maximum length of 16.
Valid Values: STANDARD | STREAMING
Request Body
The request accepts the following binary data.
Body (p. 60)
The bytes to be stored.
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json { "ContentSHA256": "string", "ETag": "string",
"StorageClass": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
ContentSHA256 (p. 61)
The SHA256 digest of the object that is persisted.
Type: String
PutObject
Length Constraints: Fixed length of 64.
Pattern: [0-9A-Fa-f]{64}
ETag (p. 61)
Unique identifier of the object in the container.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: [0-9A-Fa-f]+
StorageClass (p. 61)
The storage class where the object was persisted. The class should be “Temporal”.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 16.
Valid Values: STANDARD | TEMPORAL
Errors
For information about the errors that are common to all actions, see Common Errors (p. 76).
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