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.

Classes

NameDescription
Class Container

This section describes operations that you can perform on an AWS Elemental MediaStore container.

Class ContainerInUseException

The container that you specified in the request already exists or is being updated.

Class ContainerNotFoundException

The container that you specified in the request does not exist.

Class CorsPolicyNotFoundException

The CORS policy that you specified in the request does not exist.

Class CorsRule

A rule for a CORS policy. 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.

Class CreateContainerRequest

Container for the parameters to the CreateContainer operation. Creates a storage container to hold objects. A container is similar to a bucket in the Amazon S3 service.

Class CreateContainerResponse

This is the response object from the CreateContainer operation.

Class DeleteContainerPolicyRequest

Container for the parameters to the DeleteContainerPolicy operation. Deletes the access policy that is associated with the specified container.

Class DeleteContainerPolicyResponse

This is the response object from the DeleteContainerPolicy operation.

Class DeleteContainerRequest

Container for the parameters to the DeleteContainer operation. 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.

Class DeleteContainerResponse

This is the response object from the DeleteContainer operation.

Class DeleteCorsPolicyRequest

Container for the parameters to the DeleteCorsPolicy operation. 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.

Class DeleteCorsPolicyResponse

This is the response object from the DeleteCorsPolicy operation.

Class DeleteLifecyclePolicyRequest

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

Class DeleteLifecyclePolicyResponse

This is the response object from the DeleteLifecyclePolicy operation.

Class DeleteMetricPolicyRequest

Container for the parameters to the DeleteMetricPolicy operation. 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.

Class DeleteMetricPolicyResponse

This is the response object from the DeleteMetricPolicy operation.

Class DescribeContainerRequest

Container for the parameters to the DescribeContainer operation. 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.

Class DescribeContainerResponse

This is the response object from the DescribeContainer operation.

Class GetContainerPolicyRequest

Container for the parameters to the GetContainerPolicy operation. 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.

Class GetContainerPolicyResponse

This is the response object from the GetContainerPolicy operation.

Class GetCorsPolicyRequest

Container for the parameters to the GetCorsPolicy operation. 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.

Class GetCorsPolicyResponse

This is the response object from the GetCorsPolicy operation.

Class GetLifecyclePolicyRequest

Container for the parameters to the GetLifecyclePolicy operation. Retrieves the object lifecycle policy that is assigned to a container.

Class GetLifecyclePolicyResponse

This is the response object from the GetLifecyclePolicy operation.

Class GetMetricPolicyRequest

Container for the parameters to the GetMetricPolicy operation. Returns the metric policy for the specified container.

Class GetMetricPolicyResponse

This is the response object from the GetMetricPolicy operation.

Class InternalServerErrorException

The service is temporarily unavailable.

Class LimitExceededException

A service limit has been exceeded.

Class ListContainersRequest

Container for the parameters to the ListContainers operation. 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.

Class ListContainersResponse

This is the response object from the ListContainers operation.

Class ListTagsForResourceRequest

Container for the parameters to the ListTagsForResource operation. Returns a list of the tags assigned to the specified container.

Class ListTagsForResourceResponse

This is the response object from the ListTagsForResource operation.

Class MediaStorePaginatorFactory

Paginators for the MediaStore service

Class MetricPolicy

The metric policy that is associated with the container. A metric policy allows AWS Elemental MediaStore to send metrics to Amazon CloudWatch. In the policy, you must indicate whether you want MediaStore to send container-level metrics. You can also include rules to define groups of objects that you want MediaStore to send object-level metrics for.

To view examples of how to construct a metric policy for your use case, see Example Metric Policies.

Class MetricPolicyRule

A setting that enables metrics at the object level. Each rule contains an object group and an object group name. If the policy includes the MetricPolicyRules parameter, you must include at least one rule. Each metric policy can include up to five rules by default. You can also request a quota increase to allow up to 300 rules per policy.

Class PolicyNotFoundException

The policy that you specified in the request does not exist.

Class PutContainerPolicyRequest

Container for the parameters to the PutContainerPolicy operation. 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.

Class PutContainerPolicyResponse

This is the response object from the PutContainerPolicy operation.

Class PutCorsPolicyRequest

Container for the parameters to the PutCorsPolicy operation. 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.

Class PutCorsPolicyResponse

This is the response object from the PutCorsPolicy operation.

Class PutLifecyclePolicyRequest

Container for the parameters to the PutLifecyclePolicy operation. 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.

Class PutLifecyclePolicyResponse

This is the response object from the PutLifecyclePolicy operation.

Class PutMetricPolicyRequest

Container for the parameters to the PutMetricPolicy operation. 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.

Class PutMetricPolicyResponse

This is the response object from the PutMetricPolicy operation.

Class StartAccessLoggingRequest

Container for the parameters to the StartAccessLogging operation. 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.

Class StartAccessLoggingResponse

This is the response object from the StartAccessLogging operation.

Class StopAccessLoggingRequest

Container for the parameters to the StopAccessLogging operation. 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.

Class StopAccessLoggingResponse

This is the response object from the StopAccessLogging operation.

Class Tag

A collection of tags associated with a container. Each tag consists of a key:value pair, which can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). 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.

Class TagResourceRequest

Container for the parameters to the TagResource operation. 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.

Class TagResourceResponse

This is the response object from the TagResource operation.

Class UntagResourceRequest

Container for the parameters to the UntagResource operation. Removes tags from the specified container. You can specify one or more tags to remove.

Class UntagResourceResponse

This is the response object from the UntagResource operation.

Interfaces

NameDescription
Interface IListContainersPaginator

Paginator for the ListContainers operation

Interface IMediaStorePaginatorFactory

Paginators for the MediaStore service