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
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.
client = boto3.client("mediastore")
try:
do_something(client)
except (
client.ClientError,
client.ContainerInUseException,
client.ContainerNotFoundException,
client.CorsPolicyNotFoundException,
client.InternalServerError,
client.LimitExceededException,
client.PolicyNotFoundException,
) as e:
print(e)
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
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("mediastore").close
method.
boto3 documentation
create_container
Creates a storage container to hold objects.
Type annotations and code completion for boto3.client("mediastore").create_container
method.
boto3 documentation
def create_container(
self,
*,
ContainerName: str,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateContainerOutputTypeDef: # (2)
...
kwargs: CreateContainerInputRequestTypeDef = { # (1)
"ContainerName": ...,
}
parent.create_container(**kwargs)
delete_container
Deletes the specified container.
Type annotations and code completion for boto3.client("mediastore").delete_container
method.
boto3 documentation
kwargs: DeleteContainerInputRequestTypeDef = { # (1)
"ContainerName": ...,
}
parent.delete_container(**kwargs)
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
kwargs: DeleteContainerPolicyInputRequestTypeDef = { # (1)
"ContainerName": ...,
}
parent.delete_container_policy(**kwargs)
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
kwargs: DeleteCorsPolicyInputRequestTypeDef = { # (1)
"ContainerName": ...,
}
parent.delete_cors_policy(**kwargs)
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
kwargs: DeleteLifecyclePolicyInputRequestTypeDef = { # (1)
"ContainerName": ...,
}
parent.delete_lifecycle_policy(**kwargs)
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
kwargs: DeleteMetricPolicyInputRequestTypeDef = { # (1)
"ContainerName": ...,
}
parent.delete_metric_policy(**kwargs)
describe_container
Retrieves the properties of the requested container.
Type annotations and code completion for boto3.client("mediastore").describe_container
method.
boto3 documentation
def describe_container(
self,
*,
ContainerName: str = ...,
) -> DescribeContainerOutputTypeDef: # (1)
...
kwargs: DescribeContainerInputRequestTypeDef = { # (1)
"ContainerName": ...,
}
parent.describe_container(**kwargs)
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
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
def get_container_policy(
self,
*,
ContainerName: str,
) -> GetContainerPolicyOutputTypeDef: # (1)
...
kwargs: GetContainerPolicyInputRequestTypeDef = { # (1)
"ContainerName": ...,
}
parent.get_container_policy(**kwargs)
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
def get_cors_policy(
self,
*,
ContainerName: str,
) -> GetCorsPolicyOutputTypeDef: # (1)
...
kwargs: GetCorsPolicyInputRequestTypeDef = { # (1)
"ContainerName": ...,
}
parent.get_cors_policy(**kwargs)
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
def get_lifecycle_policy(
self,
*,
ContainerName: str,
) -> GetLifecyclePolicyOutputTypeDef: # (1)
...
kwargs: GetLifecyclePolicyInputRequestTypeDef = { # (1)
"ContainerName": ...,
}
parent.get_lifecycle_policy(**kwargs)
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
def get_metric_policy(
self,
*,
ContainerName: str,
) -> GetMetricPolicyOutputTypeDef: # (1)
...
kwargs: GetMetricPolicyInputRequestTypeDef = { # (1)
"ContainerName": ...,
}
parent.get_metric_policy(**kwargs)
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
def list_containers(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListContainersOutputTypeDef: # (1)
...
kwargs: ListContainersInputRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_containers(**kwargs)
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
def list_tags_for_resource(
self,
*,
Resource: str,
) -> ListTagsForResourceOutputTypeDef: # (1)
...
kwargs: ListTagsForResourceInputRequestTypeDef = { # (1)
"Resource": ...,
}
parent.list_tags_for_resource(**kwargs)
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
def put_container_policy(
self,
*,
ContainerName: str,
Policy: str,
) -> Dict[str, Any]:
...
kwargs: PutContainerPolicyInputRequestTypeDef = { # (1)
"ContainerName": ...,
"Policy": ...,
}
parent.put_container_policy(**kwargs)
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
def put_cors_policy(
self,
*,
ContainerName: str,
CorsPolicy: Sequence[CorsRuleTypeDef], # (1)
) -> Dict[str, Any]:
...
- See CorsRuleTypeDef
kwargs: PutCorsPolicyInputRequestTypeDef = { # (1)
"ContainerName": ...,
"CorsPolicy": ...,
}
parent.put_cors_policy(**kwargs)
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
def put_lifecycle_policy(
self,
*,
ContainerName: str,
LifecyclePolicy: str,
) -> Dict[str, Any]:
...
kwargs: PutLifecyclePolicyInputRequestTypeDef = { # (1)
"ContainerName": ...,
"LifecyclePolicy": ...,
}
parent.put_lifecycle_policy(**kwargs)
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
def put_metric_policy(
self,
*,
ContainerName: str,
MetricPolicy: MetricPolicyTypeDef, # (1)
) -> Dict[str, Any]:
...
kwargs: PutMetricPolicyInputRequestTypeDef = { # (1)
"ContainerName": ...,
"MetricPolicy": ...,
}
parent.put_metric_policy(**kwargs)
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
kwargs: StartAccessLoggingInputRequestTypeDef = { # (1)
"ContainerName": ...,
}
parent.start_access_logging(**kwargs)
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
kwargs: StopAccessLoggingInputRequestTypeDef = { # (1)
"ContainerName": ...,
}
parent.stop_access_logging(**kwargs)
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
def tag_resource(
self,
*,
Resource: str,
Tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...
- See TagTypeDef
kwargs: TagResourceInputRequestTypeDef = { # (1)
"Resource": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Removes tags from the specified container.
Type annotations and code completion for boto3.client("mediastore").untag_resource
method.
boto3 documentation
def untag_resource(
self,
*,
Resource: str,
TagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceInputRequestTypeDef = { # (1)
"Resource": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("mediastore").get_paginator
method with overloads.
client.get_paginator("list_containers")
-> ListContainersPaginator