AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Interface for accessing MediaStore

An AWS Elemental MediaStore container is a namespace that holds folders and objects. You use a container endpoint to create, read, and delete objects.

Inheritance Hierarchy

Amazon.MediaStore.IAmazonMediaStore

Namespace: Amazon.MediaStore
Assembly: AWSSDK.MediaStore.dll
Version: 3.x.y.z

Syntax

C# 
public interface IAmazonMediaStore
         IAmazonService, IDisposable

The IAmazonMediaStore type exposes the following members

Properties

NameTypeDescription
Public Property Paginators Amazon.MediaStore.Model.IMediaStorePaginatorFactory

Paginators for the service

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method CreateContainer(CreateContainerRequest)

Creates a storage container to hold objects. A container is similar to a bucket in the Amazon S3 service.

Public Method CreateContainerAsync(CreateContainerRequest, CancellationToken)

Creates a storage container to hold objects. A container is similar to a bucket in the Amazon S3 service.

Public Method DeleteContainer(DeleteContainerRequest)

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.

Public Method DeleteContainerAsync(DeleteContainerRequest, CancellationToken)

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.

Public Method DeleteContainerPolicy(DeleteContainerPolicyRequest)

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

Public Method DeleteContainerPolicyAsync(DeleteContainerPolicyRequest, CancellationToken)

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

Public Method DeleteCorsPolicy(DeleteCorsPolicyRequest)

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

To use this operation, you must have permission to perform the MediaStore:DeleteCorsPolicy action. The container owner has this permission by default and can grant this permission to others.

Public Method DeleteCorsPolicyAsync(DeleteCorsPolicyRequest, CancellationToken)

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

To use this operation, you must have permission to perform the MediaStore:DeleteCorsPolicy action. The container owner has this permission by default and can grant this permission to others.

Public Method DeleteLifecyclePolicy(DeleteLifecyclePolicyRequest)

Removes an object lifecycle policy from a container. It takes up to 20 minutes for the change to take effect.

Public Method DeleteLifecyclePolicyAsync(DeleteLifecyclePolicyRequest, CancellationToken)

Removes an object lifecycle policy from a container. It takes up to 20 minutes for the change to take effect.

Public Method DeleteMetricPolicy(DeleteMetricPolicyRequest)

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.

Public Method DeleteMetricPolicyAsync(DeleteMetricPolicyRequest, CancellationToken)

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.

Public Method DescribeContainer(DescribeContainerRequest)

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 single Container object based on ContainerName. To return all Container objects that are associated with a specified AWS account, use ListContainers.

Public Method DescribeContainerAsync(DescribeContainerRequest, CancellationToken)

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 single Container object based on ContainerName. To return all Container objects that are associated with a specified AWS account, use ListContainers.

Public Method DetermineServiceOperationEndpoint(AmazonWebServiceRequest)

Returns the endpoint that will be used for a particular request.

Public Method GetContainerPolicy(GetContainerPolicyRequest)

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.

Public Method GetContainerPolicyAsync(GetContainerPolicyRequest, CancellationToken)

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.

Public Method GetCorsPolicy(GetCorsPolicyRequest)

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

To use this operation, you must have permission to perform the MediaStore:GetCorsPolicy action. By default, the container owner has this permission and can grant it to others.

Public Method GetCorsPolicyAsync(GetCorsPolicyRequest, CancellationToken)

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

To use this operation, you must have permission to perform the MediaStore:GetCorsPolicy action. By default, the container owner has this permission and can grant it to others.

Public Method GetLifecyclePolicy(GetLifecyclePolicyRequest)

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

Public Method GetLifecyclePolicyAsync(GetLifecyclePolicyRequest, CancellationToken)

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

Public Method GetMetricPolicy(GetMetricPolicyRequest)

Returns the metric policy for the specified container.

Public Method GetMetricPolicyAsync(GetMetricPolicyRequest, CancellationToken)

Returns the metric policy for the specified container.

Public Method ListContainers(ListContainersRequest)

Lists the properties of all containers in AWS Elemental MediaStore.

You can query to receive all the containers in one response. Or you can include the MaxResults parameter to receive a limited number of containers in each response. In this case, the response includes a token. To get the next set of containers, send the command again, this time with the NextToken parameter (with the returned token as its value). The next set of responses appears, with a token if there are still more containers to receive.

See also DescribeContainer, which gets the properties of one container.

Public Method ListContainersAsync(ListContainersRequest, CancellationToken)

Lists the properties of all containers in AWS Elemental MediaStore.

You can query to receive all the containers in one response. Or you can include the MaxResults parameter to receive a limited number of containers in each response. In this case, the response includes a token. To get the next set of containers, send the command again, this time with the NextToken parameter (with the returned token as its value). The next set of responses appears, with a token if there are still more containers to receive.

See also DescribeContainer, which gets the properties of one container.

Public Method ListTagsForResource(ListTagsForResourceRequest)

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

Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

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

Public Method PutContainerPolicy(PutContainerPolicyRequest)

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.

For this release of the REST API, you can create only one policy for a container. If you enter PutContainerPolicy twice, the second command modifies the existing policy.

Public Method PutContainerPolicyAsync(PutContainerPolicyRequest, CancellationToken)

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.

For this release of the REST API, you can create only one policy for a container. If you enter PutContainerPolicy twice, the second command modifies the existing policy.

Public Method PutCorsPolicy(PutCorsPolicyRequest)

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.

To enable CORS on a container, you attach a CORS policy to the container. In the CORS policy, you configure rules that identify origins and the HTTP methods that can be executed on your container. The policy can contain up to 398,000 characters. You can add up to 100 rules to a CORS policy. If more than one rule applies, the service uses the first applicable rule listed.

To learn more about CORS, see Cross-Origin Resource Sharing (CORS) in AWS Elemental MediaStore.

Public Method PutCorsPolicyAsync(PutCorsPolicyRequest, CancellationToken)

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.

To enable CORS on a container, you attach a CORS policy to the container. In the CORS policy, you configure rules that identify origins and the HTTP methods that can be executed on your container. The policy can contain up to 398,000 characters. You can add up to 100 rules to a CORS policy. If more than one rule applies, the service uses the first applicable rule listed.

To learn more about CORS, see Cross-Origin Resource Sharing (CORS) in AWS Elemental MediaStore.

Public Method PutLifecyclePolicy(PutLifecyclePolicyRequest)

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.

For information about how to construct an object lifecycle policy, see Components of an Object Lifecycle Policy.

Public Method PutLifecyclePolicyAsync(PutLifecyclePolicyRequest, CancellationToken)

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.

For information about how to construct an object lifecycle policy, see Components of an Object Lifecycle Policy.

Public Method PutMetricPolicy(PutMetricPolicyRequest)

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.

Public Method PutMetricPolicyAsync(PutMetricPolicyRequest, CancellationToken)

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.

Public Method StartAccessLogging(StartAccessLoggingRequest)

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.

Public Method StartAccessLoggingAsync(StartAccessLoggingRequest, CancellationToken)

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.

Public Method StopAccessLogging(StopAccessLoggingRequest)

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.

Public Method StopAccessLoggingAsync(StopAccessLoggingRequest, CancellationToken)

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.

Public Method TagResource(TagResourceRequest)

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.

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

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.

Public Method UntagResource(UntagResourceRequest)

Removes tags from the specified container. You can specify one or more tags to remove.

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

Removes tags from the specified container. You can specify one or more tags to remove.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5