com.amazonaws.services.mediastore

Class AWSMediaStoreClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.mediastore.AWSMediaStoreClient

All Implemented Interfaces:

AWSMediaStore

Direct Known Subclasses:

AWSMediaStoreAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSMediaStoreClient
extends AmazonWebServiceClient
implements AWSMediaStore

Client for accessing MediaStore. All service calls made using this client are blocking, and will not return until the service call completes.

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
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.mediastore.AWSMediaStore

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSMediaStoreClientBuilder	builder()
CreateContainerResult	createContainer(CreateContainerRequest request) Creates a storage container to hold objects.
DeleteContainerResult	deleteContainer(DeleteContainerRequest request) Deletes the specified container.
DeleteContainerPolicyResult	deleteContainerPolicy(DeleteContainerPolicyRequest request) Deletes the access policy that is associated with the specified container.
DeleteCorsPolicyResult	deleteCorsPolicy(DeleteCorsPolicyRequest request) Deletes the cross-origin resource sharing (CORS) configuration information that is set for the container.
DescribeContainerResult	describeContainer(DescribeContainerRequest request) 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 request) Retrieves the access policy for the specified container.
GetCorsPolicyResult	getCorsPolicy(GetCorsPolicyRequest request) Returns the cross-origin resource sharing (CORS) configuration information that is set for the container.
ListContainersResult	listContainers(ListContainersRequest request) Lists the properties of all containers in AWS Elemental MediaStore.
PutContainerPolicyResult	putContainerPolicy(PutContainerPolicyRequest request) Creates an access policy for the specified container to restrict the users and clients that can access it.
PutCorsPolicyResult	putCorsPolicy(PutCorsPolicyRequest request) Sets the cross-origin resource sharing (CORS) configuration on a container so that the container can service cross-origin requests.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, shutdown, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.mediastore.AWSMediaStore

shutdown

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AWSMediaStoreClientBuilder builder()

createContainer

public CreateContainerResult createContainer(CreateContainerRequest request)

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

Specified by:

createContainer in interface AWSMediaStore

Parameters:

createContainerRequest -

Returns:

Result of the CreateContainer operation returned by the service.

Throws:

ContainerInUseException - Resource 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

public DeleteContainerResult deleteContainer(DeleteContainerRequest request)

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.

Specified by:

deleteContainer in interface AWSMediaStore

Parameters:

deleteContainerRequest -

Returns:

Result of the DeleteContainer operation returned by the service.

Throws:

ContainerInUseException - Resource already exists or is being updated.

ContainerNotFoundException - Could not perform an operation on a container that does not exist.

InternalServerErrorException - The service is temporarily unavailable.

See Also:

AWS API Documentation

deleteContainerPolicy

public DeleteContainerPolicyResult deleteContainerPolicy(DeleteContainerPolicyRequest request)

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

Specified by:

deleteContainerPolicy in interface AWSMediaStore

Parameters:

deleteContainerPolicyRequest -

Returns:

Result of the DeleteContainerPolicy operation returned by the service.

Throws:

ContainerInUseException - Resource already exists or is being updated.

ContainerNotFoundException - Could not perform an operation on a container that does not exist.

PolicyNotFoundException - Could not perform an operation on a policy that does not exist.

InternalServerErrorException - The service is temporarily unavailable.

See Also:

AWS API Documentation

deleteCorsPolicy

public DeleteCorsPolicyResult deleteCorsPolicy(DeleteCorsPolicyRequest request)

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.

Specified by:

deleteCorsPolicy in interface AWSMediaStore

Parameters:

deleteCorsPolicyRequest -

Returns:

Result of the DeleteCorsPolicy operation returned by the service.

Throws:

ContainerInUseException - Resource already exists or is being updated.

ContainerNotFoundException - Could not perform an operation on a container that does not exist.

CorsPolicyNotFoundException - Could not perform an operation on a policy that does not exist.

InternalServerErrorException - The service is temporarily unavailable.

See Also:

AWS API Documentation

describeContainer

public DescribeContainerResult describeContainer(DescribeContainerRequest request)

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.

Specified by:

describeContainer in interface AWSMediaStore

Parameters:

describeContainerRequest -

Returns:

Result of the DescribeContainer operation returned by the service.

Throws:

ContainerNotFoundException - Could not perform an operation on a container that does not exist.

InternalServerErrorException - The service is temporarily unavailable.

See Also:

AWS API Documentation

getContainerPolicy

public GetContainerPolicyResult getContainerPolicy(GetContainerPolicyRequest request)

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.

Specified by:

getContainerPolicy in interface AWSMediaStore

Parameters:

getContainerPolicyRequest -

Returns:

Result of the GetContainerPolicy operation returned by the service.

Throws:

ContainerInUseException - Resource already exists or is being updated.

ContainerNotFoundException - Could not perform an operation on a container that does not exist.

PolicyNotFoundException - Could not perform an operation on a policy that does not exist.

InternalServerErrorException - The service is temporarily unavailable.

See Also:

AWS API Documentation

getCorsPolicy

public GetCorsPolicyResult getCorsPolicy(GetCorsPolicyRequest request)

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.

Specified by:

getCorsPolicy in interface AWSMediaStore

Parameters:

getCorsPolicyRequest -

Returns:

Result of the GetCorsPolicy operation returned by the service.

Throws:

ContainerInUseException - Resource already exists or is being updated.

ContainerNotFoundException - Could not perform an operation on a container that does not exist.

CorsPolicyNotFoundException - Could not perform an operation on a policy that does not exist.

InternalServerErrorException - The service is temporarily unavailable.

See Also:

AWS API Documentation

listContainers

public ListContainersResult listContainers(ListContainersRequest request)

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.

Specified by:

listContainers in interface AWSMediaStore

Parameters:

listContainersRequest -

Returns:

Result of the ListContainers operation returned by the service.

Throws:

InternalServerErrorException - The service is temporarily unavailable.

See Also:

AWS API Documentation

putContainerPolicy

public PutContainerPolicyResult putContainerPolicy(PutContainerPolicyRequest request)

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.

Specified by:

putContainerPolicy in interface AWSMediaStore

Parameters:

putContainerPolicyRequest -

Returns:

Result of the PutContainerPolicy operation returned by the service.

Throws:

ContainerNotFoundException - Could not perform an operation on a container that does not exist.

ContainerInUseException - Resource already exists or is being updated.

InternalServerErrorException - The service is temporarily unavailable.

See Also:

AWS API Documentation

putCorsPolicy

public PutCorsPolicyResult putCorsPolicy(PutCorsPolicyRequest request)

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.

Specified by:

putCorsPolicy in interface AWSMediaStore

Parameters:

putCorsPolicyRequest -

Returns:

Result of the PutCorsPolicy operation returned by the service.

Throws:

ContainerNotFoundException - Could not perform an operation on a container that does not exist.

ContainerInUseException - Resource already exists or is being updated.

InternalServerErrorException - The service is temporarily unavailable.

See Also:

AWS API Documentation

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AWSMediaStore

Parameters:

request - The originally executed request

Returns:

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