NAME

Paws::MediaStore - Perl Interface to AWS AWS Elemental MediaStore

SYNOPSIS

  use Paws;
  my $obj = Paws->service('MediaStore');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

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

For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/mediastore-2017-09-01>

METHODS

CreateContainer

ContainerName => Str
[Tags => ArrayRef[Paws::MediaStore::Tag]]

Each argument is described in detail in: Paws::MediaStore::CreateContainer

Returns: a Paws::MediaStore::CreateContainerOutput instance

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

DeleteContainer

ContainerName => Str

Each argument is described in detail in: Paws::MediaStore::DeleteContainer

Returns: a Paws::MediaStore::DeleteContainerOutput instance

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

ContainerName => Str

Each argument is described in detail in: Paws::MediaStore::DeleteContainerPolicy

Returns: a Paws::MediaStore::DeleteContainerPolicyOutput instance

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

DeleteCorsPolicy

ContainerName => Str

Each argument is described in detail in: Paws::MediaStore::DeleteCorsPolicy

Returns: a Paws::MediaStore::DeleteCorsPolicyOutput instance

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.

DeleteLifecyclePolicy

ContainerName => Str

Each argument is described in detail in: Paws::MediaStore::DeleteLifecyclePolicy

Returns: a Paws::MediaStore::DeleteLifecyclePolicyOutput instance

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

DeleteMetricPolicy

ContainerName => Str

Each argument is described in detail in: Paws::MediaStore::DeleteMetricPolicy

Returns: a Paws::MediaStore::DeleteMetricPolicyOutput instance

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

[ContainerName => Str]

Each argument is described in detail in: Paws::MediaStore::DescribeContainer

Returns: a Paws::MediaStore::DescribeContainerOutput instance

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.

GetContainerPolicy

ContainerName => Str

Each argument is described in detail in: Paws::MediaStore::GetContainerPolicy

Returns: a Paws::MediaStore::GetContainerPolicyOutput instance

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 (https://aws.amazon.com/documentation/iam/).

GetCorsPolicy

ContainerName => Str

Each argument is described in detail in: Paws::MediaStore::GetCorsPolicy

Returns: a Paws::MediaStore::GetCorsPolicyOutput instance

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.

GetLifecyclePolicy

ContainerName => Str

Each argument is described in detail in: Paws::MediaStore::GetLifecyclePolicy

Returns: a Paws::MediaStore::GetLifecyclePolicyOutput instance

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

GetMetricPolicy

ContainerName => Str

Each argument is described in detail in: Paws::MediaStore::GetMetricPolicy

Returns: a Paws::MediaStore::GetMetricPolicyOutput instance

Returns the metric policy for the specified container.

ListContainers

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::MediaStore::ListContainers

Returns: a Paws::MediaStore::ListContainersOutput instance

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.

ListTagsForResource

Resource => Str

Each argument is described in detail in: Paws::MediaStore::ListTagsForResource

Returns: a Paws::MediaStore::ListTagsForResourceOutput instance

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

Each argument is described in detail in: Paws::MediaStore::PutContainerPolicy

Returns: a Paws::MediaStore::PutContainerPolicyOutput instance

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 (https://aws.amazon.com/documentation/iam/).

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.

PutCorsPolicy

ContainerName => Str
CorsPolicy => ArrayRef[Paws::MediaStore::CorsRule]

Each argument is described in detail in: Paws::MediaStore::PutCorsPolicy

Returns: a Paws::MediaStore::PutCorsPolicyOutput instance

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 (https://docs.aws.amazon.com/mediastore/latest/ug/cors-policy.html).

PutLifecyclePolicy

ContainerName => Str
LifecyclePolicy => Str

Each argument is described in detail in: Paws::MediaStore::PutLifecyclePolicy

Returns: a Paws::MediaStore::PutLifecyclePolicyOutput instance

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 (https://docs.aws.amazon.com/mediastore/latest/ug/policies-object-lifecycle-components.html).

PutMetricPolicy

ContainerName => Str
MetricPolicy => Paws::MediaStore::MetricPolicy

Each argument is described in detail in: Paws::MediaStore::PutMetricPolicy

Returns: a Paws::MediaStore::PutMetricPolicyOutput instance

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

ContainerName => Str

Each argument is described in detail in: Paws::MediaStore::StartAccessLogging

Returns: a Paws::MediaStore::StartAccessLoggingOutput instance

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

ContainerName => Str

Each argument is described in detail in: Paws::MediaStore::StopAccessLogging

Returns: a Paws::MediaStore::StopAccessLoggingOutput instance

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

Resource => Str
Tags => ArrayRef[Paws::MediaStore::Tag]

Each argument is described in detail in: Paws::MediaStore::TagResource

Returns: a Paws::MediaStore::TagResourceOutput instance

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 (https://docs.aws.amazon.com/mediastore/latest/ug/tagging.html).

UntagResource

Resource => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::MediaStore::UntagResource

Returns: a Paws::MediaStore::UntagResourceOutput instance

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

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

ListAllContainers(sub { },[MaxResults => Int, NextToken => Str])

ListAllContainers([MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Containers, passing the object as the first parameter, and the string 'Containers' as the second parameter

If not, it will return a a Paws::MediaStore::ListContainersOutput instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>