SDK for PHP 3.x

Client: Aws\MediaStore\MediaStoreClient
Service ID: mediastore
Version: 2017-09-01

This page describes the parameters and results for the operations of the AWS Elemental MediaStore (2017-09-01), and shows how to use the Aws\MediaStore\MediaStoreClient object to call the described operations. This documentation is specific to the 2017-09-01 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CreateContainer ( array $params = [] )
Creates a storage container to hold objects.
DeleteContainer ( array $params = [] )
Deletes the specified container.
DeleteContainerPolicy ( array $params = [] )
Deletes the access policy that is associated with the specified container.
DeleteCorsPolicy ( array $params = [] )
Deletes the cross-origin resource sharing (CORS) configuration information that is set for the container.
DeleteLifecyclePolicy ( array $params = [] )
Removes an object lifecycle policy from a container.
DeleteMetricPolicy ( array $params = [] )
Deletes the metric policy that is associated with the specified container.
DescribeContainer ( array $params = [] )
Retrieves the properties of the requested container.
GetContainerPolicy ( array $params = [] )
Retrieves the access policy for the specified container.
GetCorsPolicy ( array $params = [] )
Returns the cross-origin resource sharing (CORS) configuration information that is set for the container.
GetLifecyclePolicy ( array $params = [] )
Retrieves the object lifecycle policy that is assigned to a container.
GetMetricPolicy ( array $params = [] )
Returns the metric policy for the specified container.
ListContainers ( array $params = [] )
Lists the properties of all containers in AWS Elemental MediaStore.
ListTagsForResource ( array $params = [] )
Returns a list of the tags assigned to the specified container.
PutContainerPolicy ( array $params = [] )
Creates an access policy for the specified container to restrict the users and clients that can access it.
PutCorsPolicy ( array $params = [] )
Sets the cross-origin resource sharing (CORS) configuration on a container so that the container can service cross-origin requests.
PutLifecyclePolicy ( array $params = [] )
Writes an object lifecycle policy to a container.
PutMetricPolicy ( array $params = [] )
The metric policy that you want to add to the container.
StartAccessLogging ( array $params = [] )
Starts access logging on the specified container.
StopAccessLogging ( array $params = [] )
Stops access logging on the specified container.
TagResource ( array $params = [] )
Adds tags to the specified AWS Elemental MediaStore container.
UntagResource ( array $params = [] )
Removes tags from the specified container.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListContainers

Operations

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

Members
ContainerName
Required: Yes
Type: string

The name for the container. The name must be from 1 to 255 characters. Container names must be unique to your AWS account within a specific region. As an example, you could create a container named movies in every region, as long as you don’t have an existing container with that name.

Tags
Type: Array of Tag structures

An array of key:value pairs that you define. These values can be anything that you want. 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.

Result Syntax

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

Result Details

Members
Container
Required: Yes
Type: Container structure

ContainerARN: The Amazon Resource Name (ARN) of the newly created container. The ARN has the following format: arn:aws:<region>:<account that owns this container>:container/<name of container>. For example: arn:aws:mediastore:us-west-2:111122223333:container/movies

ContainerName: The container name as specified in the request.

CreationTime: Unix time stamp.

Status: The status of container creation or deletion. The status is one of the following: CREATING, ACTIVE, or DELETING. While the service is creating the container, the status is CREATING. When an endpoint is available, the status changes to ACTIVE.

The return value does not include the container's endpoint. To make downstream requests, you must obtain this value by using DescribeContainer or ListContainers.

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

Members
ContainerName
Required: Yes
Type: string

The name of the container to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members
ContainerName
Required: Yes
Type: string

The name of the container that holds the policy.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members
ContainerName
Required: Yes
Type: string

The name of the container to remove the policy from.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members
ContainerName
Required: Yes
Type: string

The name of the container that holds the object lifecycle policy.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members
ContainerName
Required: Yes
Type: string

The name of the container that is associated with the metric policy that you want to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members
ContainerName
Type: string

The name of the container to query.

Result Syntax

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

Result Details

Members
Container
Type: Container structure

The name of the queried container.

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

Members
ContainerName
Required: Yes
Type: string

The name of the container.

Result Syntax

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

Result Details

Members
Policy
Required: Yes
Type: string

The contents of the access policy.

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

Members
ContainerName
Required: Yes
Type: string

The name of the container that the policy is assigned to.

Result Syntax

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

Result Details

Members
CorsPolicy
Required: Yes
Type: Array of CorsRule structures

The CORS policy assigned to the container.

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

Members
ContainerName
Required: Yes
Type: string

The name of the container that the object lifecycle policy is assigned to.

Result Syntax

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

Result Details

Members
LifecyclePolicy
Required: Yes
Type: string

The object lifecycle policy that is assigned to the container.

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

Members
ContainerName
Required: Yes
Type: string

The name of the container that is associated with the metric policy.

Result Syntax

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

Result Details

Members
MetricPolicy
Required: Yes
Type: MetricPolicy structure

The metric policy that is associated with the specific container.

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

Members
MaxResults
Type: int

Enter the maximum number of containers in the response. Use from 1 to 255 characters.

NextToken
Type: string

Only if you used MaxResults in the first command, enter the token (which was included in the previous response) to obtain the next set of containers. This token is included in a response only if there actually are more containers to list.

Result Syntax

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

Result Details

Members
Containers
Required: Yes
Type: Array of Container structures

The names of the containers.

NextToken
Type: string

NextToken is the token to use in the next call to ListContainers. This token is returned only if you included the MaxResults tag in the original command, and only if there are still containers to return.

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

Members
Resource
Required: Yes
Type: string

The Amazon Resource Name (ARN) for the container.

Result Syntax

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

Result Details

Members
Tags
Type: Array of Tag structures

An array of key:value pairs that are assigned to the container.

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

Members
ContainerName
Required: Yes
Type: string

The name of the container.

Policy
Required: Yes
Type: string

The contents of the policy, which includes the following:

  • One Version tag

  • One Statement tag that contains the standard tags for the policy.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members
ContainerName
Required: Yes
Type: string

The name of the container that you want to assign the CORS policy to.

CorsPolicy
Required: Yes
Type: Array of CorsRule structures

The CORS policy to apply to the container.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members
ContainerName
Required: Yes
Type: string

The name of the container that you want to assign the object lifecycle policy to.

LifecyclePolicy
Required: Yes
Type: string

The object lifecycle policy to apply to the container.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members
ContainerName
Required: Yes
Type: string

The name of the container that you want to add the metric policy to.

MetricPolicy
Required: Yes
Type: MetricPolicy structure

The metric policy that you want to associate with the container. In the policy, you must indicate whether you want MediaStore to send container-level metrics. You can also include up to five rules to define groups of objects that you want MediaStore to send object-level metrics for. If you include rules in the policy, construct each rule with both of the following:

  • An object group that defines which objects to include in the group. The definition can be a path or a file name, but it can't have more than 900 characters. Valid characters are: a-z, A-Z, 0-9, _ (underscore), = (equal), : (colon), . (period), - (hyphen), ~ (tilde), / (forward slash), and * (asterisk). Wildcards (*) are acceptable.

  • An object group name that allows you to refer to the object group. The name can't have more than 30 characters. Valid characters are: a-z, A-Z, 0-9, and _ (underscore).

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members
ContainerName
Required: Yes
Type: string

The name of the container that you want to start access logging on.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members
ContainerName
Required: Yes
Type: string

The name of the container that you want to stop access logging on.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members
Resource
Required: Yes
Type: string

The Amazon Resource Name (ARN) for the container.

Tags
Required: Yes
Type: Array of Tag structures

An array of key:value pairs that you want to add to the container. You need to specify only the tags that you want to add or update. For example, suppose a container already has two tags (customer:CompanyA and priority:High). You want to change the priority tag and also add a third tag (type:Contract). For TagResource, you specify the following tags: priority:Medium, type:Contract. The result is that your container has three tags: customer:CompanyA, priority:Medium, and type:Contract.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members
Resource
Required: Yes
Type: string

The Amazon Resource Name (ARN) for the container.

TagKeys
Required: Yes
Type: Array of strings

A comma-separated list of keys for tags that you want to remove from the container. For example, if your container has two tags (customer:CompanyA and priority:High) and you want to remove one of the tags (priority:High), you specify the key for the tag that you want to remove (priority).

Result Syntax

[]

Result Details

The results for this operation are always empty.

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.

Shapes

Container

Description

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

Members
ARN
Type: string

The Amazon Resource Name (ARN) of the container. The ARN has the following format:

arn:aws:<region>:<account that owns this container>:container/<name of container>

For example: arn:aws:mediastore:us-west-2:111122223333:container/movies

AccessLoggingEnabled
Type: boolean

The state of access logging on the container. This value is false by default, indicating that AWS Elemental MediaStore does not send access logs to Amazon CloudWatch Logs. When you enable access logging on the container, MediaStore changes this value to true, indicating that the service delivers access logs for objects stored in that container to CloudWatch Logs.

CreationTime
Type: timestamp (string|DateTime or anything parsable by strtotime)

Unix timestamp.

Endpoint
Type: string

The DNS endpoint of the container. Use the endpoint to identify the specific container when sending requests to the data plane. The service assigns this value when the container is created. Once the value has been assigned, it does not change.

Name
Type: string

The name of the container.

Status
Type: string

The status of container creation or deletion. The status is one of the following: CREATING, ACTIVE, or DELETING. While the service is creating the container, the status is CREATING. When the endpoint is available, the status changes to ACTIVE.

ContainerInUseException

Description

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

Members
Message
Type: string

ContainerNotFoundException

Description

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

Members
Message
Type: string

CorsPolicyNotFoundException

Description

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

Members
Message
Type: string

CorsRule

Description

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.

Members
AllowedHeaders
Required: Yes
Type: Array of strings

Specifies which headers are allowed in a preflight OPTIONS request through the Access-Control-Request-Headers header. Each header name that is specified in Access-Control-Request-Headers must have a corresponding entry in the rule. Only the headers that were requested are sent back.

This element can contain only one wildcard character (*).

AllowedMethods
Type: Array of strings

Identifies an HTTP method that the origin that is specified in the rule is allowed to execute.

Each CORS rule must contain at least one AllowedMethods and one AllowedOrigins element.

AllowedOrigins
Required: Yes
Type: Array of strings

One or more response headers that you want users to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).

Each CORS rule must have at least one AllowedOrigins element. The string value can include only one wildcard character (*), for example, http://*.example.com. Additionally, you can specify only one wildcard character to allow cross-origin access for all origins.

ExposeHeaders
Type: Array of strings

One or more headers in the response that you want users to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).

This element is optional for each rule.

MaxAgeSeconds
Type: int

The time in seconds that your browser caches the preflight response for the specified resource.

A CORS rule can have only one MaxAgeSeconds element.

InternalServerError

Description

The service is temporarily unavailable.

Members
Message
Type: string

LimitExceededException

Description

A service limit has been exceeded.

Members
Message
Type: string

MetricPolicy

Description

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.

Members
ContainerLevelMetrics
Required: Yes
Type: string

A setting to enable or disable metrics at the container level.

MetricPolicyRules
Type: Array of MetricPolicyRule structures

A parameter that holds an array of rules that enable metrics at the object level. This parameter is optional, but if you choose to include it, you must also include at least one rule. By default, you can include up to five rules. You can also request a quota increase to allow up to 300 rules per policy.

MetricPolicyRule

Description

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.

Members
ObjectGroup
Required: Yes
Type: string

A path or file name that defines which objects to include in the group. Wildcards (*) are acceptable.

ObjectGroupName
Required: Yes
Type: string

A name that allows you to refer to the object group.

PolicyNotFoundException

Description

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

Members
Message
Type: string

Tag

Description

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.

Members
Key
Required: Yes
Type: string

Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.

Value
Type: string

Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.