MediaStoreData / Client / describe_object

describe_object#

MediaStoreData.Client.describe_object(**kwargs)#

Gets the headers for an object at the specified path.

Request Syntax

response = client.describe_object(
    Path='string'
)

Parameters:

Path (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'ETag': 'string',
    'ContentType': 'string',
    'ContentLength': 123,
    'CacheControl': 'string',
    'LastModified': datetime(2015, 1, 1)
}

Response Structure

(dict) –
- ETag (string) –
  
  The ETag that represents a unique instance of the object.
- ContentType (string) –
  
  The content type of the object.
- ContentLength (integer) –
  
  The length of the object in bytes.
- 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 at https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.
  
  Headers with a custom user-defined value are also accepted.
- LastModified (datetime) –
  
  The date and time that the object was last modified.

Exceptions

MediaStoreData.Client.exceptions.ContainerNotFoundException
MediaStoreData.Client.exceptions.ObjectNotFoundException
MediaStoreData.Client.exceptions.InternalServerError