Table of Contents
A low-level client representing AWS Elemental MediaStore Data Plane:
client = session.create_client('mediastore-data')
These are the available methods:
Check if an operation can be paginated.
Deletes an object at the specified path.
See also: AWS API Documentation
Request Syntax
response = client.delete_object(
Path='string'
)
[REQUIRED]
The path (including the file name) where the object is stored in the container. Format: <folder name>/<folder name>/<file name>
{}
Response Structure
Gets the headers for an object at the specified path.
See also: AWS API Documentation
Request Syntax
response = client.describe_object(
Path='string'
)
[REQUIRED]
The path (including the file name) where the object is stored in the container. Format: <folder name>/<folder name>/<file name>
{
'ETag': 'string',
'ContentType': 'string',
'ContentLength': 123,
'CacheControl': 'string',
'LastModified': datetime(2015, 1, 1)
}
Response Structure
The ETag that represents a unique instance of the object.
The content type of the object.
The length of the object in bytes.
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.
The date and time that the object was last modified.
Generate a presigned url given a client, its method, and arguments
The presigned url
Downloads the object at the specified path.
See also: AWS API Documentation
Request Syntax
response = client.get_object(
Path='string',
Range='string'
)
[REQUIRED]
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.
dict
Response Syntax
{
'Body': StreamingBody(),
'CacheControl': 'string',
'ContentRange': 'string',
'ContentLength': 123,
'ContentType': 'string',
'ETag': 'string',
'LastModified': datetime(2015, 1, 1),
'StatusCode': 123
}
Response Structure
(dict) --
Body (StreamingBody) --
The bytes of the object.
CacheControl (string) --
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.
ContentRange (string) --
The range of bytes to retrieve.
ContentLength (integer) --
The length of the object in bytes.
ContentType (string) --
The content type of the object.
ETag (string) --
The ETag that represents a unique instance of the object.
LastModified (datetime) --
The date and time that the object was last modified.
StatusCode (integer) --
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.
Create a paginator for an operation.
Returns an object that can wait for some condition.
Provides a list of metadata entries about folders and objects in the specified folder.
See also: AWS API Documentation
Request Syntax
response = client.list_items(
Path='string',
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'Items': [
{
'Name': 'string',
'Type': 'OBJECT'|'FOLDER',
'ETag': 'string',
'LastModified': datetime(2015, 1, 1),
'ContentType': 'string',
'ContentLength': 123
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
Metadata entries for the folders and objects at the requested path.
(dict) --
A metadata entry for a folder or object.
Name (string) --
The name of the item.
Type (string) --
The item type (folder or object).
ETag (string) --
The ETag that represents a unique instance of the item.
LastModified (datetime) --
The date and time that the item was last modified.
ContentType (string) --
The content type of the item.
ContentLength (integer) --
The length of the item in bytes.
NextToken (string) --
The NextToken used to request the next page of results using ListItems .
Uploads an object to the specified path. Object sizes are limited to 10 MB.
See also: AWS API Documentation
Request Syntax
response = client.put_object(
Body=b'bytes'|file,
Path='string',
ContentType='string',
CacheControl='string',
StorageClass='TEMPORAL'
)
[REQUIRED]
The bytes to be stored.
[REQUIRED]
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.
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.
dict
Response Syntax
{
'ContentSHA256': 'string',
'ETag': 'string',
'StorageClass': 'TEMPORAL'
}
Response Structure
(dict) --
ContentSHA256 (string) --
The SHA256 digest of the object that is persisted.
ETag (string) --
Unique identifier of the object in the container.
StorageClass (string) --
The storage class where the object was persisted. Should be “Temporal”.
The available paginators are: