Skip to content

MediaStoreClient#

Index > MediaStore > MediaStoreClient

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

MediaStoreClient#

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

# MediaStoreClient usage example

from boto3.session import Session
from mypy_boto3_mediastore.client import MediaStoreClient

def get_mediastore_client() -> MediaStoreClient:
    return Session().client("mediastore")

Exceptions#

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

# Exceptions.exceptions usage example

client = boto3.client("mediastore")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.ContainerInUseException,
    client.exceptions.ContainerNotFoundException,
    client.exceptions.CorsPolicyNotFoundException,
    client.exceptions.InternalServerError,
    client.exceptions.LimitExceededException,
    client.exceptions.PolicyNotFoundException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_mediastore.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").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").close method. boto3 documentation

# close method definition

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

create_container#

Creates a storage container to hold objects.

Type annotations and code completion for boto3.client("mediastore").create_container method. boto3 documentation

# create_container method definition

def create_container(
    self,
    *,
    ContainerName: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateContainerOutputTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateContainerOutputTypeDef 
# create_container method usage example with argument unpacking

kwargs: CreateContainerInputRequestTypeDef = {  # (1)
    "ContainerName": ...,
}

parent.create_container(**kwargs)
  1. See CreateContainerInputRequestTypeDef

delete_container#

Deletes the specified container.

Type annotations and code completion for boto3.client("mediastore").delete_container method. boto3 documentation

# delete_container method definition

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

kwargs: DeleteContainerInputRequestTypeDef = {  # (1)
    "ContainerName": ...,
}

parent.delete_container(**kwargs)
  1. See DeleteContainerInputRequestTypeDef

delete_container_policy#

Deletes the access policy that is associated with the specified container.

Type annotations and code completion for boto3.client("mediastore").delete_container_policy method. boto3 documentation

# delete_container_policy method definition

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

kwargs: DeleteContainerPolicyInputRequestTypeDef = {  # (1)
    "ContainerName": ...,
}

parent.delete_container_policy(**kwargs)
  1. See DeleteContainerPolicyInputRequestTypeDef

delete_cors_policy#

Deletes the cross-origin resource sharing (CORS) configuration information that is set for the container.

Type annotations and code completion for boto3.client("mediastore").delete_cors_policy method. boto3 documentation

# delete_cors_policy method definition

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

kwargs: DeleteCorsPolicyInputRequestTypeDef = {  # (1)
    "ContainerName": ...,
}

parent.delete_cors_policy(**kwargs)
  1. See DeleteCorsPolicyInputRequestTypeDef

delete_lifecycle_policy#

Removes an object lifecycle policy from a container.

Type annotations and code completion for boto3.client("mediastore").delete_lifecycle_policy method. boto3 documentation

# delete_lifecycle_policy method definition

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

kwargs: DeleteLifecyclePolicyInputRequestTypeDef = {  # (1)
    "ContainerName": ...,
}

parent.delete_lifecycle_policy(**kwargs)
  1. See DeleteLifecyclePolicyInputRequestTypeDef

delete_metric_policy#

Deletes the metric policy that is associated with the specified container.

Type annotations and code completion for boto3.client("mediastore").delete_metric_policy method. boto3 documentation

# delete_metric_policy method definition

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

kwargs: DeleteMetricPolicyInputRequestTypeDef = {  # (1)
    "ContainerName": ...,
}

parent.delete_metric_policy(**kwargs)
  1. See DeleteMetricPolicyInputRequestTypeDef

describe_container#

Retrieves the properties of the requested container.

Type annotations and code completion for boto3.client("mediastore").describe_container method. boto3 documentation

# describe_container method definition

def describe_container(
    self,
    *,
    ContainerName: str = ...,
) -> DescribeContainerOutputTypeDef:  # (1)
    ...
  1. See DescribeContainerOutputTypeDef 
# describe_container method usage example with argument unpacking

kwargs: DescribeContainerInputRequestTypeDef = {  # (1)
    "ContainerName": ...,
}

parent.describe_container(**kwargs)
  1. See DescribeContainerInputRequestTypeDef

generate_presigned_url#

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

Type annotations and code completion for boto3.client("mediastore").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_container_policy#

Retrieves the access policy for the specified container.

Type annotations and code completion for boto3.client("mediastore").get_container_policy method. boto3 documentation

# get_container_policy method definition

def get_container_policy(
    self,
    *,
    ContainerName: str,
) -> GetContainerPolicyOutputTypeDef:  # (1)
    ...
  1. See GetContainerPolicyOutputTypeDef 
# get_container_policy method usage example with argument unpacking

kwargs: GetContainerPolicyInputRequestTypeDef = {  # (1)
    "ContainerName": ...,
}

parent.get_container_policy(**kwargs)
  1. See GetContainerPolicyInputRequestTypeDef

get_cors_policy#

Returns the cross-origin resource sharing (CORS) configuration information that is set for the container.

Type annotations and code completion for boto3.client("mediastore").get_cors_policy method. boto3 documentation

# get_cors_policy method definition

def get_cors_policy(
    self,
    *,
    ContainerName: str,
) -> GetCorsPolicyOutputTypeDef:  # (1)
    ...
  1. See GetCorsPolicyOutputTypeDef 
# get_cors_policy method usage example with argument unpacking

kwargs: GetCorsPolicyInputRequestTypeDef = {  # (1)
    "ContainerName": ...,
}

parent.get_cors_policy(**kwargs)
  1. See GetCorsPolicyInputRequestTypeDef

get_lifecycle_policy#

Retrieves the object lifecycle policy that is assigned to a container.

Type annotations and code completion for boto3.client("mediastore").get_lifecycle_policy method. boto3 documentation

# get_lifecycle_policy method definition

def get_lifecycle_policy(
    self,
    *,
    ContainerName: str,
) -> GetLifecyclePolicyOutputTypeDef:  # (1)
    ...
  1. See GetLifecyclePolicyOutputTypeDef 
# get_lifecycle_policy method usage example with argument unpacking

kwargs: GetLifecyclePolicyInputRequestTypeDef = {  # (1)
    "ContainerName": ...,
}

parent.get_lifecycle_policy(**kwargs)
  1. See GetLifecyclePolicyInputRequestTypeDef

get_metric_policy#

Returns the metric policy for the specified container.

Type annotations and code completion for boto3.client("mediastore").get_metric_policy method. boto3 documentation

# get_metric_policy method definition

def get_metric_policy(
    self,
    *,
    ContainerName: str,
) -> GetMetricPolicyOutputTypeDef:  # (1)
    ...
  1. See GetMetricPolicyOutputTypeDef 
# get_metric_policy method usage example with argument unpacking

kwargs: GetMetricPolicyInputRequestTypeDef = {  # (1)
    "ContainerName": ...,
}

parent.get_metric_policy(**kwargs)
  1. See GetMetricPolicyInputRequestTypeDef

list_containers#

Lists the properties of all containers in AWS Elemental MediaStore.

Type annotations and code completion for boto3.client("mediastore").list_containers method. boto3 documentation

# list_containers method definition

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

kwargs: ListContainersInputRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_containers(**kwargs)
  1. See ListContainersInputRequestTypeDef

list_tags_for_resource#

Returns a list of the tags assigned to the specified container.

Type annotations and code completion for boto3.client("mediastore").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    Resource: str,
) -> ListTagsForResourceOutputTypeDef:  # (1)
    ...
  1. See ListTagsForResourceOutputTypeDef 
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceInputRequestTypeDef = {  # (1)
    "Resource": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceInputRequestTypeDef

put_container_policy#

Creates an access policy for the specified container to restrict the users and clients that can access it.

Type annotations and code completion for boto3.client("mediastore").put_container_policy method. boto3 documentation

# put_container_policy method definition

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

kwargs: PutContainerPolicyInputRequestTypeDef = {  # (1)
    "ContainerName": ...,
    "Policy": ...,
}

parent.put_container_policy(**kwargs)
  1. See PutContainerPolicyInputRequestTypeDef

put_cors_policy#

Sets the cross-origin resource sharing (CORS) configuration on a container so that the container can service cross-origin requests.

Type annotations and code completion for boto3.client("mediastore").put_cors_policy method. boto3 documentation

# put_cors_policy method definition

def put_cors_policy(
    self,
    *,
    ContainerName: str,
    CorsPolicy: Sequence[CorsRuleUnionTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See CorsRuleTypeDef CorsRuleOutputTypeDef 
# put_cors_policy method usage example with argument unpacking

kwargs: PutCorsPolicyInputRequestTypeDef = {  # (1)
    "ContainerName": ...,
    "CorsPolicy": ...,
}

parent.put_cors_policy(**kwargs)
  1. See PutCorsPolicyInputRequestTypeDef

put_lifecycle_policy#

Writes an object lifecycle policy to a container.

Type annotations and code completion for boto3.client("mediastore").put_lifecycle_policy method. boto3 documentation

# put_lifecycle_policy method definition

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

kwargs: PutLifecyclePolicyInputRequestTypeDef = {  # (1)
    "ContainerName": ...,
    "LifecyclePolicy": ...,
}

parent.put_lifecycle_policy(**kwargs)
  1. See PutLifecyclePolicyInputRequestTypeDef

put_metric_policy#

The metric policy that you want to add to the container.

Type annotations and code completion for boto3.client("mediastore").put_metric_policy method. boto3 documentation

# put_metric_policy method definition

def put_metric_policy(
    self,
    *,
    ContainerName: str,
    MetricPolicy: MetricPolicyTypeDef,  # (1)
) -> Dict[str, Any]:
    ...
  1. See MetricPolicyTypeDef 
# put_metric_policy method usage example with argument unpacking

kwargs: PutMetricPolicyInputRequestTypeDef = {  # (1)
    "ContainerName": ...,
    "MetricPolicy": ...,
}

parent.put_metric_policy(**kwargs)
  1. See PutMetricPolicyInputRequestTypeDef

start_access_logging#

Starts access logging on the specified container.

Type annotations and code completion for boto3.client("mediastore").start_access_logging method. boto3 documentation

# start_access_logging method definition

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

kwargs: StartAccessLoggingInputRequestTypeDef = {  # (1)
    "ContainerName": ...,
}

parent.start_access_logging(**kwargs)
  1. See StartAccessLoggingInputRequestTypeDef

stop_access_logging#

Stops access logging on the specified container.

Type annotations and code completion for boto3.client("mediastore").stop_access_logging method. boto3 documentation

# stop_access_logging method definition

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

kwargs: StopAccessLoggingInputRequestTypeDef = {  # (1)
    "ContainerName": ...,
}

parent.stop_access_logging(**kwargs)
  1. See StopAccessLoggingInputRequestTypeDef

tag_resource#

Adds tags to the specified AWS Elemental MediaStore container.

Type annotations and code completion for boto3.client("mediastore").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    Resource: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See TagTypeDef 
# tag_resource method usage example with argument unpacking

kwargs: TagResourceInputRequestTypeDef = {  # (1)
    "Resource": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceInputRequestTypeDef

untag_resource#

Removes tags from the specified container.

Type annotations and code completion for boto3.client("mediastore").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    Resource: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceInputRequestTypeDef = {  # (1)
    "Resource": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceInputRequestTypeDef

get_paginator#

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