Mediastore Data
This page documents function available when using the Mediastore_Data
module, created with @service Mediastore_Data
.
Index
Main.Mediastore_Data.delete_object
Main.Mediastore_Data.describe_object
Main.Mediastore_Data.get_object
Main.Mediastore_Data.list_items
Main.Mediastore_Data.put_object
Documentation
Main.Mediastore_Data.delete_object
— Methoddelete_object(path)
delete_object(path, params::Dict{String,<:Any})
Deletes an object at the specified path.
Arguments
path
: The path (including the file name) where the object is stored in the container. Format: <folder name>/<folder name>/<file name>
Main.Mediastore_Data.describe_object
— Methoddescribe_object(path)
describe_object(path, params::Dict{String,<:Any})
Gets the headers for an object at the specified path.
Arguments
path
: The path (including the file name) where the object is stored in the container. Format: <folder name>/<folder name>/<file name>
Main.Mediastore_Data.get_object
— Methodget_object(path)
get_object(path, params::Dict{String,<:Any})
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.
Arguments
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 premiumcanada 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.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"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.
Main.Mediastore_Data.list_items
— Methodlist_items()
list_items(params::Dict{String,<:Any})
Provides a list of metadata entries about folders and objects in the specified folder.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"MaxResults"
: 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."NextToken"
: 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"
: The path in the container from which to retrieve items. Format: <folder name>/<folder name>/<file name>
Main.Mediastore_Data.put_object
— Methodput_object(body, path)
put_object(body, path, params::Dict{String,<:Any})
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.
Arguments
body
: The bytes to be stored.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 premiumcanada 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.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"Cache-Control"
: 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."Content-Type"
: The content type of the object."x-amz-storage-class"
: 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."x-amz-upload-availability"
: 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.