CreateContainer

$result = $client->createContainer([/* ... */]);
$promise = $client->createContainerAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createContainer([
    'ContainerName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Container' => [
        'ARN' => '<string>',
        'AccessLoggingEnabled' => true || false,
        'CreationTime' => <DateTime>,
        'Endpoint' => '<string>',
        'Name' => '<string>',
        'Status' => 'ACTIVE|CREATING|DELETING',
    ],
]

Result Details

Errors

ContainerInUseException:

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

LimitExceededException:

A service limit has been exceeded.

InternalServerError:

The service is temporarily unavailable.

DeleteContainer

$result = $client->deleteContainer([/* ... */]);
$promise = $client->deleteContainerAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteContainer([
    'ContainerName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ContainerInUseException:

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

ContainerNotFoundException:

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

InternalServerError:

The service is temporarily unavailable.

DeleteContainerPolicy

$result = $client->deleteContainerPolicy([/* ... */]);
$promise = $client->deleteContainerPolicyAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteContainerPolicy([
    'ContainerName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ContainerInUseException:

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

ContainerNotFoundException:

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

PolicyNotFoundException:

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

InternalServerError:

The service is temporarily unavailable.

DeleteCorsPolicy

$result = $client->deleteCorsPolicy([/* ... */]);
$promise = $client->deleteCorsPolicyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteCorsPolicy([
    'ContainerName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ContainerInUseException:

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

ContainerNotFoundException:

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

CorsPolicyNotFoundException:

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

InternalServerError:

The service is temporarily unavailable.

DeleteLifecyclePolicy

$result = $client->deleteLifecyclePolicy([/* ... */]);
$promise = $client->deleteLifecyclePolicyAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteLifecyclePolicy([
    'ContainerName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ContainerInUseException:

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

ContainerNotFoundException:

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

PolicyNotFoundException:

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

InternalServerError:

The service is temporarily unavailable.

DeleteMetricPolicy

$result = $client->deleteMetricPolicy([/* ... */]);
$promise = $client->deleteMetricPolicyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteMetricPolicy([
    'ContainerName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ContainerInUseException:

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

ContainerNotFoundException:

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

PolicyNotFoundException:

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

InternalServerError:

The service is temporarily unavailable.

DescribeContainer

$result = $client->describeContainer([/* ... */]);
$promise = $client->describeContainerAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeContainer([
    'ContainerName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Container' => [
        'ARN' => '<string>',
        'AccessLoggingEnabled' => true || false,
        'CreationTime' => <DateTime>,
        'Endpoint' => '<string>',
        'Name' => '<string>',
        'Status' => 'ACTIVE|CREATING|DELETING',
    ],
]

Result Details

Errors

ContainerNotFoundException:

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

InternalServerError:

The service is temporarily unavailable.

GetContainerPolicy

$result = $client->getContainerPolicy([/* ... */]);
$promise = $client->getContainerPolicyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getContainerPolicy([
    'ContainerName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Policy' => '<string>',
]

Result Details

Errors

ContainerInUseException:

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

ContainerNotFoundException:

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

PolicyNotFoundException:

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

InternalServerError:

The service is temporarily unavailable.

GetCorsPolicy

$result = $client->getCorsPolicy([/* ... */]);
$promise = $client->getCorsPolicyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getCorsPolicy([
    'ContainerName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CorsPolicy' => [
        [
            'AllowedHeaders' => ['<string>', ...],
            'AllowedMethods' => ['<string>', ...],
            'AllowedOrigins' => ['<string>', ...],
            'ExposeHeaders' => ['<string>', ...],
            'MaxAgeSeconds' => <integer>,
        ],
        // ...
    ],
]

Result Details

Errors

ContainerInUseException:

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

ContainerNotFoundException:

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

CorsPolicyNotFoundException:

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

InternalServerError:

The service is temporarily unavailable.

GetLifecyclePolicy

$result = $client->getLifecyclePolicy([/* ... */]);
$promise = $client->getLifecyclePolicyAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getLifecyclePolicy([
    'ContainerName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'LifecyclePolicy' => '<string>',
]

Result Details

Errors

ContainerInUseException:

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

ContainerNotFoundException:

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

PolicyNotFoundException:

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

InternalServerError:

The service is temporarily unavailable.

GetMetricPolicy

$result = $client->getMetricPolicy([/* ... */]);
$promise = $client->getMetricPolicyAsync([/* ... */]);

Returns the metric policy for the specified container.

Parameter Syntax

$result = $client->getMetricPolicy([
    'ContainerName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'MetricPolicy' => [
        'ContainerLevelMetrics' => 'ENABLED|DISABLED',
        'MetricPolicyRules' => [
            [
                'ObjectGroup' => '<string>',
                'ObjectGroupName' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

Errors

ContainerNotFoundException:

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

PolicyNotFoundException:

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

ContainerInUseException:

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

InternalServerError:

The service is temporarily unavailable.

ListContainers

$result = $client->listContainers([/* ... */]);
$promise = $client->listContainersAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listContainers([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Containers' => [
        [
            'ARN' => '<string>',
            'AccessLoggingEnabled' => true || false,
            'CreationTime' => <DateTime>,
            'Endpoint' => '<string>',
            'Name' => '<string>',
            'Status' => 'ACTIVE|CREATING|DELETING',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InternalServerError:

The service is temporarily unavailable.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listTagsForResource([
    'Resource' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ContainerInUseException:

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

ContainerNotFoundException:

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

InternalServerError:

The service is temporarily unavailable.

PutContainerPolicy

$result = $client->putContainerPolicy([/* ... */]);
$promise = $client->putContainerPolicyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->putContainerPolicy([
    'ContainerName' => '<string>', // REQUIRED
    'Policy' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ContainerNotFoundException:

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

ContainerInUseException:

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

InternalServerError:

The service is temporarily unavailable.

PutCorsPolicy

$result = $client->putCorsPolicy([/* ... */]);
$promise = $client->putCorsPolicyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->putCorsPolicy([
    'ContainerName' => '<string>', // REQUIRED
    'CorsPolicy' => [ // REQUIRED
        [
            'AllowedHeaders' => ['<string>', ...], // REQUIRED
            'AllowedMethods' => ['<string>', ...],
            'AllowedOrigins' => ['<string>', ...], // REQUIRED
            'ExposeHeaders' => ['<string>', ...],
            'MaxAgeSeconds' => <integer>,
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ContainerNotFoundException:

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

ContainerInUseException:

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

InternalServerError:

The service is temporarily unavailable.

PutLifecyclePolicy

$result = $client->putLifecyclePolicy([/* ... */]);
$promise = $client->putLifecyclePolicyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->putLifecyclePolicy([
    'ContainerName' => '<string>', // REQUIRED
    'LifecyclePolicy' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ContainerInUseException:

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

ContainerNotFoundException:

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

InternalServerError:

The service is temporarily unavailable.

PutMetricPolicy

$result = $client->putMetricPolicy([/* ... */]);
$promise = $client->putMetricPolicyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->putMetricPolicy([
    'ContainerName' => '<string>', // REQUIRED
    'MetricPolicy' => [ // REQUIRED
        'ContainerLevelMetrics' => 'ENABLED|DISABLED', // REQUIRED
        'MetricPolicyRules' => [
            [
                'ObjectGroup' => '<string>', // REQUIRED
                'ObjectGroupName' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ContainerInUseException:

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

ContainerNotFoundException:

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

InternalServerError:

The service is temporarily unavailable.

StartAccessLogging

$result = $client->startAccessLogging([/* ... */]);
$promise = $client->startAccessLoggingAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->startAccessLogging([
    'ContainerName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ContainerInUseException:

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

ContainerNotFoundException:

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

InternalServerError:

The service is temporarily unavailable.

StopAccessLogging

$result = $client->stopAccessLogging([/* ... */]);
$promise = $client->stopAccessLoggingAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->stopAccessLogging([
    'ContainerName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ContainerInUseException:

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

ContainerNotFoundException:

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

InternalServerError:

The service is temporarily unavailable.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->tagResource([
    'Resource' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ContainerInUseException:

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

ContainerNotFoundException:

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

InternalServerError:

The service is temporarily unavailable.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

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

Parameter Syntax

$result = $client->untagResource([
    'Resource' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ContainerInUseException:

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

ContainerNotFoundException:

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

InternalServerError:

The service is temporarily unavailable.