MediaStore class
An AWS Elemental MediaStore container is a namespace that holds folders and objects. You use a container endpoint to create, read, and delete objects.
Constructors
- MediaStore({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
close(
) → void - Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
-
createContainer(
{required String containerName, List< Tag> ? tags}) → Future<CreateContainerOutput> - Creates a storage container to hold objects. A container is similar to a bucket in the Amazon S3 service.
-
deleteContainer(
{required String containerName}) → Future< void> -
Deletes the specified container. Before you make a
DeleteContainer
request, delete any objects in the container or in any folders in the container. You can delete only empty containers. -
deleteContainerPolicy(
{required String containerName}) → Future< void> - Deletes the access policy that is associated with the specified container.
-
deleteCorsPolicy(
{required String containerName}) → Future< void> - Deletes the cross-origin resource sharing (CORS) configuration information that is set for the container.
-
deleteLifecyclePolicy(
{required String containerName}) → Future< void> - Removes an object lifecycle policy from a container. It takes up to 20 minutes for the change to take effect.
-
deleteMetricPolicy(
{required String containerName}) → Future< void> - Deletes the metric policy that is associated with the specified container. If there is no metric policy associated with the container, MediaStore doesn't send metrics to CloudWatch.
-
describeContainer(
{String? containerName}) → Future< DescribeContainerOutput> -
Retrieves the properties of the requested container. This request is
commonly used to retrieve the endpoint of a container. An endpoint is a
value assigned by the service when a new container is created. A
container's endpoint does not change after it has been assigned. The
DescribeContainer
request returns a singleContainer
object based onContainerName
. To return allContainer
objects that are associated with a specified AWS account, use ListContainers. -
getContainerPolicy(
{required String containerName}) → Future< GetContainerPolicyOutput> - Retrieves the access policy for the specified container. For information about the data that is included in an access policy, see the AWS Identity and Access Management User Guide.
-
getCorsPolicy(
{required String containerName}) → Future< GetCorsPolicyOutput> - Returns the cross-origin resource sharing (CORS) configuration information that is set for the container.
-
getLifecyclePolicy(
{required String containerName}) → Future< GetLifecyclePolicyOutput> - Retrieves the object lifecycle policy that is assigned to a container.
-
getMetricPolicy(
{required String containerName}) → Future< GetMetricPolicyOutput> - Returns the metric policy for the specified container.
-
listContainers(
{int? maxResults, String? nextToken}) → Future< ListContainersOutput> - Lists the properties of all containers in AWS Elemental MediaStore.
-
listTagsForResource(
{required String resource}) → Future< ListTagsForResourceOutput> - Returns a list of the tags assigned to the specified container.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
putContainerPolicy(
{required String containerName, required String policy}) → Future< void> - Creates an access policy for the specified container to restrict the users and clients that can access it. For information about the data that is included in an access policy, see the AWS Identity and Access Management User Guide.
-
putCorsPolicy(
{required String containerName, required List< CorsRule> corsPolicy}) → Future<void> - Sets the cross-origin resource sharing (CORS) configuration on a container so that the container can service cross-origin requests. For example, you might want to enable a request whose origin is http://www.example.com to access your AWS Elemental MediaStore container at my.example.container.com by using the browser's XMLHttpRequest capability.
-
putLifecyclePolicy(
{required String containerName, required String lifecyclePolicy}) → Future< void> - Writes an object lifecycle policy to a container. If the container already has an object lifecycle policy, the service replaces the existing policy with the new policy. It takes up to 20 minutes for the change to take effect.
-
putMetricPolicy(
{required String containerName, required MetricPolicy metricPolicy}) → Future< void> - The metric policy that you want to add to the container. A metric policy allows AWS Elemental MediaStore to send metrics to Amazon CloudWatch. It takes up to 20 minutes for the new policy to take effect.
-
startAccessLogging(
{required String containerName}) → Future< void> - Starts access logging on the specified container. When you enable access logging on a container, MediaStore delivers access logs for objects stored in that container to Amazon CloudWatch Logs.
-
stopAccessLogging(
{required String containerName}) → Future< void> - Stops access logging on the specified container. When you stop access logging on a container, MediaStore stops sending access logs to Amazon CloudWatch Logs. These access logs are not saved and are not retrievable.
-
tagResource(
{required String resource, required List< Tag> tags}) → Future<void> - Adds tags to the specified AWS Elemental MediaStore container. Tags are key:value pairs that you can associate with AWS resources. For example, the tag key might be "customer" and the tag value might be "companyA." You can specify one or more tags to add to each container. You can add up to 50 tags to each container. For more information about tagging, including naming and usage conventions, see Tagging Resources in MediaStore.
-
toString(
) → String -
A string representation of this object.
inherited
-
untagResource(
{required String resource, required List< String> tagKeys}) → Future<void> - Removes tags from the specified container. You can specify one or more tags to remove.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited