Skip to content

MediaStoreDataClient#

Index > MediaStoreData > MediaStoreDataClient

Auto-generated documentation for MediaStoreData type annotations stubs module mypy-boto3-mediastore-data.

MediaStoreDataClient#

Type annotations and code completion for boto3.client("mediastore-data"). boto3 documentation

# MediaStoreDataClient usage example

from boto3.session import Session
from mypy_boto3_mediastore_data.client import MediaStoreDataClient

def get_mediastore-data_client() -> MediaStoreDataClient:
    return Session().client("mediastore-data")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("mediastore-data").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("mediastore-data")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.ContainerNotFoundException,
    client.exceptions.InternalServerError,
    client.exceptions.ObjectNotFoundException,
    client.exceptions.RequestedRangeNotSatisfiableException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_mediastore_data.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods#

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("mediastore-data").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("mediastore-data").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

delete_object#

Deletes an object at the specified path.

Type annotations and code completion for boto3.client("mediastore-data").delete_object method. boto3 documentation

# delete_object method definition

def delete_object(
    self,
    *,
    Path: str,
) -> Dict[str, Any]:
    ...
# delete_object method usage example with argument unpacking

kwargs: DeleteObjectRequestRequestTypeDef = {  # (1)
    "Path": ...,
}

parent.delete_object(**kwargs)
  1. See DeleteObjectRequestRequestTypeDef

describe_object#

Gets the headers for an object at the specified path.

Type annotations and code completion for boto3.client("mediastore-data").describe_object method. boto3 documentation

# describe_object method definition

def describe_object(
    self,
    *,
    Path: str,
) -> DescribeObjectResponseTypeDef:  # (1)
    ...
  1. See DescribeObjectResponseTypeDef 
# describe_object method usage example with argument unpacking

kwargs: DescribeObjectRequestRequestTypeDef = {  # (1)
    "Path": ...,
}

parent.describe_object(**kwargs)
  1. See DescribeObjectRequestRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("mediastore-data").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_object#

Downloads the object at the specified path.

Type annotations and code completion for boto3.client("mediastore-data").get_object method. boto3 documentation

# get_object method definition

def get_object(
    self,
    *,
    Path: str,
    Range: str = ...,
) -> GetObjectResponseTypeDef:  # (1)
    ...
  1. See GetObjectResponseTypeDef 
# get_object method usage example with argument unpacking

kwargs: GetObjectRequestRequestTypeDef = {  # (1)
    "Path": ...,
}

parent.get_object(**kwargs)
  1. See GetObjectRequestRequestTypeDef

list_items#

Provides a list of metadata entries about folders and objects in the specified folder.

Type annotations and code completion for boto3.client("mediastore-data").list_items method. boto3 documentation

# list_items method definition

def list_items(
    self,
    *,
    Path: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListItemsResponseTypeDef:  # (1)
    ...
  1. See ListItemsResponseTypeDef 
# list_items method usage example with argument unpacking

kwargs: ListItemsRequestRequestTypeDef = {  # (1)
    "Path": ...,
}

parent.list_items(**kwargs)
  1. See ListItemsRequestRequestTypeDef

put_object#

Uploads an object to the specified path.

Type annotations and code completion for boto3.client("mediastore-data").put_object method. boto3 documentation

# put_object method definition

def put_object(
    self,
    *,
    Body: BlobTypeDef,
    Path: str,
    ContentType: str = ...,
    CacheControl: str = ...,
    StorageClass: StorageClassType = ...,  # (1)
    UploadAvailability: UploadAvailabilityType = ...,  # (2)
) -> PutObjectResponseTypeDef:  # (3)
    ...
  1. See StorageClassType
  2. See UploadAvailabilityType
  3. See PutObjectResponseTypeDef 
# put_object method usage example with argument unpacking

kwargs: PutObjectRequestRequestTypeDef = {  # (1)
    "Body": ...,
    "Path": ...,
}

parent.put_object(**kwargs)
  1. See PutObjectRequestRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("mediastore-data").get_paginator method with overloads.