com.amazonaws.services.mediastore

Interface AWSMediaStore

All Known Subinterfaces:

AWSMediaStoreAsync

All Known Implementing Classes:

AbstractAWSMediaStore, AbstractAWSMediaStoreAsync, AWSMediaStoreAsyncClient, AWSMediaStoreClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSMediaStore

Interface for accessing MediaStore.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSMediaStore instead.

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateContainerResult	createContainer(CreateContainerRequest createContainerRequest) Creates a storage container to hold objects.
DeleteContainerResult	deleteContainer(DeleteContainerRequest deleteContainerRequest) Deletes the specified container.
DeleteContainerPolicyResult	deleteContainerPolicy(DeleteContainerPolicyRequest deleteContainerPolicyRequest) Deletes the access policy that is associated with the specified container.
DeleteCorsPolicyResult	deleteCorsPolicy(DeleteCorsPolicyRequest deleteCorsPolicyRequest) Deletes the cross-origin resource sharing (CORS) configuration information that is set for the container.
DeleteLifecyclePolicyResult	deleteLifecyclePolicy(DeleteLifecyclePolicyRequest deleteLifecyclePolicyRequest) Removes an object lifecycle policy from a container.
DeleteMetricPolicyResult	deleteMetricPolicy(DeleteMetricPolicyRequest deleteMetricPolicyRequest) Deletes the metric policy that is associated with the specified container.
DescribeContainerResult	describeContainer(DescribeContainerRequest describeContainerRequest) Retrieves the properties of the requested container.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetContainerPolicyResult	getContainerPolicy(GetContainerPolicyRequest getContainerPolicyRequest) Retrieves the access policy for the specified container.
GetCorsPolicyResult	getCorsPolicy(GetCorsPolicyRequest getCorsPolicyRequest) Returns the cross-origin resource sharing (CORS) configuration information that is set for the container.
GetLifecyclePolicyResult	getLifecyclePolicy(GetLifecyclePolicyRequest getLifecyclePolicyRequest) Retrieves the object lifecycle policy that is assigned to a container.
GetMetricPolicyResult	getMetricPolicy(GetMetricPolicyRequest getMetricPolicyRequest) Returns the metric policy for the specified container.
ListContainersResult	listContainers(ListContainersRequest listContainersRequest) Lists the properties of all containers in AWS Elemental MediaStore.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Returns a list of the tags assigned to the specified container.
PutContainerPolicyResult	putContainerPolicy(PutContainerPolicyRequest putContainerPolicyRequest) Creates an access policy for the specified container to restrict the users and clients that can access it.
PutCorsPolicyResult	putCorsPolicy(PutCorsPolicyRequest putCorsPolicyRequest) Sets the cross-origin resource sharing (CORS) configuration on a container so that the container can service cross-origin requests.
PutLifecyclePolicyResult	putLifecyclePolicy(PutLifecyclePolicyRequest putLifecyclePolicyRequest) Writes an object lifecycle policy to a container.
PutMetricPolicyResult	putMetricPolicy(PutMetricPolicyRequest putMetricPolicyRequest) The metric policy that you want to add to the container.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartAccessLoggingResult	startAccessLogging(StartAccessLoggingRequest startAccessLoggingRequest) Starts access logging on the specified container.
StopAccessLoggingResult	stopAccessLogging(StopAccessLoggingRequest stopAccessLoggingRequest) Stops access logging on the specified container.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Adds tags to the specified AWS Elemental MediaStore container.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes tags from the specified container.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createContainer

CreateContainerResult createContainer(CreateContainerRequest createContainerRequest)

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

Parameters:

createContainerRequest -

Returns:

Result of the CreateContainer operation returned by the service.

Throws:

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

LimitExceededException - A service limit has been exceeded.

InternalServerErrorException - The service is temporarily unavailable.

See Also:

AWS API Documentation

deleteContainer

DeleteContainerResult deleteContainer(DeleteContainerRequest 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.

Parameters:

deleteContainerRequest -

Returns:

Result of the DeleteContainer operation returned by the service.

Throws:

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.

InternalServerErrorException - The service is temporarily unavailable.

See Also:

AWS API Documentation

deleteContainerPolicy

DeleteContainerPolicyResult deleteContainerPolicy(DeleteContainerPolicyRequest deleteContainerPolicyRequest)

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

Parameters:

deleteContainerPolicyRequest -

Returns:

Result of the DeleteContainerPolicy operation returned by the service.

Throws:

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.

InternalServerErrorException - The service is temporarily unavailable.

See Also:

AWS API Documentation

deleteCorsPolicy

DeleteCorsPolicyResult deleteCorsPolicy(DeleteCorsPolicyRequest 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.

Parameters:

deleteCorsPolicyRequest -

Returns:

Result of the DeleteCorsPolicy operation returned by the service.

Throws:

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.

InternalServerErrorException - The service is temporarily unavailable.

See Also:

AWS API Documentation

deleteLifecyclePolicy

DeleteLifecyclePolicyResult deleteLifecyclePolicy(DeleteLifecyclePolicyRequest deleteLifecyclePolicyRequest)

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

Parameters:

deleteLifecyclePolicyRequest -

Returns:

Result of the DeleteLifecyclePolicy operation returned by the service.

Throws:

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.

InternalServerErrorException - The service is temporarily unavailable.

See Also:

AWS API Documentation

deleteMetricPolicy

DeleteMetricPolicyResult deleteMetricPolicy(DeleteMetricPolicyRequest 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.

Parameters:

deleteMetricPolicyRequest -

Returns:

Result of the DeleteMetricPolicy operation returned by the service.

Throws:

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.

InternalServerErrorException - The service is temporarily unavailable.

See Also:

AWS API Documentation

describeContainer

DescribeContainerResult describeContainer(DescribeContainerRequest 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.

Parameters:

describeContainerRequest -

Returns:

Result of the DescribeContainer operation returned by the service.

Throws:

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

InternalServerErrorException - The service is temporarily unavailable.

See Also:

AWS API Documentation

getContainerPolicy

GetContainerPolicyResult getContainerPolicy(GetContainerPolicyRequest 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.

Parameters:

getContainerPolicyRequest -

Returns:

Result of the GetContainerPolicy operation returned by the service.

Throws:

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.

InternalServerErrorException - The service is temporarily unavailable.

See Also:

AWS API Documentation

getCorsPolicy

GetCorsPolicyResult getCorsPolicy(GetCorsPolicyRequest 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.

Parameters:

getCorsPolicyRequest -

Returns:

Result of the GetCorsPolicy operation returned by the service.

Throws:

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.

InternalServerErrorException - The service is temporarily unavailable.

See Also:

AWS API Documentation

getLifecyclePolicy

GetLifecyclePolicyResult getLifecyclePolicy(GetLifecyclePolicyRequest getLifecyclePolicyRequest)

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

Parameters:

getLifecyclePolicyRequest -

Returns:

Result of the GetLifecyclePolicy operation returned by the service.

Throws:

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.

InternalServerErrorException - The service is temporarily unavailable.

See Also:

AWS API Documentation

getMetricPolicy

GetMetricPolicyResult getMetricPolicy(GetMetricPolicyRequest getMetricPolicyRequest)

Returns the metric policy for the specified container.

Parameters:

getMetricPolicyRequest -

Returns:

Result of the GetMetricPolicy operation returned by the service.

Throws:

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.

InternalServerErrorException - The service is temporarily unavailable.

See Also:

AWS API Documentation

listContainers

ListContainersResult listContainers(ListContainersRequest 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.

Parameters:

listContainersRequest -

Returns:

Result of the ListContainers operation returned by the service.

Throws:

InternalServerErrorException - The service is temporarily unavailable.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

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

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

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.

InternalServerErrorException - The service is temporarily unavailable.

See Also:

AWS API Documentation

putContainerPolicy

PutContainerPolicyResult putContainerPolicy(PutContainerPolicyRequest 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.

Parameters:

putContainerPolicyRequest -

Returns:

Result of the PutContainerPolicy operation returned by the service.

Throws:

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.

InternalServerErrorException - The service is temporarily unavailable.

See Also:

AWS API Documentation

putCorsPolicy

PutCorsPolicyResult putCorsPolicy(PutCorsPolicyRequest 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.

Parameters:

putCorsPolicyRequest -

Returns:

Result of the PutCorsPolicy operation returned by the service.

Throws:

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.

InternalServerErrorException - The service is temporarily unavailable.

See Also:

AWS API Documentation

putLifecyclePolicy

PutLifecyclePolicyResult putLifecyclePolicy(PutLifecyclePolicyRequest 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.

Parameters:

putLifecyclePolicyRequest -

Returns:

Result of the PutLifecyclePolicy operation returned by the service.

Throws:

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.

InternalServerErrorException - The service is temporarily unavailable.

See Also:

AWS API Documentation

putMetricPolicy

PutMetricPolicyResult putMetricPolicy(PutMetricPolicyRequest 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.

Parameters:

putMetricPolicyRequest -

Returns:

Result of the PutMetricPolicy operation returned by the service.

Throws:

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.

InternalServerErrorException - The service is temporarily unavailable.

See Also:

AWS API Documentation

startAccessLogging

StartAccessLoggingResult startAccessLogging(StartAccessLoggingRequest 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.

Parameters:

startAccessLoggingRequest -

Returns:

Result of the StartAccessLogging operation returned by the service.

Throws:

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.

InternalServerErrorException - The service is temporarily unavailable.

See Also:

AWS API Documentation

stopAccessLogging

StopAccessLoggingResult stopAccessLogging(StopAccessLoggingRequest 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.

Parameters:

stopAccessLoggingRequest -

Returns:

Result of the StopAccessLogging operation returned by the service.

Throws:

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.

InternalServerErrorException - The service is temporarily unavailable.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest 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.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

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.

InternalServerErrorException - The service is temporarily unavailable.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

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

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

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.

InternalServerErrorException - The service is temporarily unavailable.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.