Interface MediaStoreClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface MediaStoreClient
extends AwsClient

Service client for accessing MediaStore. This can be created using the static builder() method.

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	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static MediaStoreClientBuilder	builder()	Create a builder that can be used to configure and create a MediaStoreClient.
static MediaStoreClient	create()	Create a MediaStoreClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateContainerResponse	createContainer(Consumer<CreateContainerRequest.Builder> createContainerRequest)	Creates a storage container to hold objects.
default CreateContainerResponse	createContainer(CreateContainerRequest createContainerRequest)	Creates a storage container to hold objects.
default DeleteContainerResponse	deleteContainer(Consumer<DeleteContainerRequest.Builder> deleteContainerRequest)	Deletes the specified container.
default DeleteContainerResponse	deleteContainer(DeleteContainerRequest deleteContainerRequest)	Deletes the specified container.
default DeleteContainerPolicyResponse	deleteContainerPolicy(Consumer<DeleteContainerPolicyRequest.Builder> deleteContainerPolicyRequest)	Deletes the access policy that is associated with the specified container.
default DeleteContainerPolicyResponse	deleteContainerPolicy(DeleteContainerPolicyRequest deleteContainerPolicyRequest)	Deletes the access policy that is associated with the specified container.
default DeleteCorsPolicyResponse	deleteCorsPolicy(Consumer<DeleteCorsPolicyRequest.Builder> deleteCorsPolicyRequest)	Deletes the cross-origin resource sharing (CORS) configuration information that is set for the container.
default DeleteCorsPolicyResponse	deleteCorsPolicy(DeleteCorsPolicyRequest deleteCorsPolicyRequest)	Deletes the cross-origin resource sharing (CORS) configuration information that is set for the container.
default DeleteLifecyclePolicyResponse	deleteLifecyclePolicy(Consumer<DeleteLifecyclePolicyRequest.Builder> deleteLifecyclePolicyRequest)	Removes an object lifecycle policy from a container.
default DeleteLifecyclePolicyResponse	deleteLifecyclePolicy(DeleteLifecyclePolicyRequest deleteLifecyclePolicyRequest)	Removes an object lifecycle policy from a container.
default DeleteMetricPolicyResponse	deleteMetricPolicy(Consumer<DeleteMetricPolicyRequest.Builder> deleteMetricPolicyRequest)	Deletes the metric policy that is associated with the specified container.
default DeleteMetricPolicyResponse	deleteMetricPolicy(DeleteMetricPolicyRequest deleteMetricPolicyRequest)	Deletes the metric policy that is associated with the specified container.
default DescribeContainerResponse	describeContainer(Consumer<DescribeContainerRequest.Builder> describeContainerRequest)	Retrieves the properties of the requested container.
default DescribeContainerResponse	describeContainer(DescribeContainerRequest describeContainerRequest)	Retrieves the properties of the requested container.
default GetContainerPolicyResponse	getContainerPolicy(Consumer<GetContainerPolicyRequest.Builder> getContainerPolicyRequest)	Retrieves the access policy for the specified container.
default GetContainerPolicyResponse	getContainerPolicy(GetContainerPolicyRequest getContainerPolicyRequest)	Retrieves the access policy for the specified container.
default GetCorsPolicyResponse	getCorsPolicy(Consumer<GetCorsPolicyRequest.Builder> getCorsPolicyRequest)	Returns the cross-origin resource sharing (CORS) configuration information that is set for the container.
default GetCorsPolicyResponse	getCorsPolicy(GetCorsPolicyRequest getCorsPolicyRequest)	Returns the cross-origin resource sharing (CORS) configuration information that is set for the container.
default GetLifecyclePolicyResponse	getLifecyclePolicy(Consumer<GetLifecyclePolicyRequest.Builder> getLifecyclePolicyRequest)	Retrieves the object lifecycle policy that is assigned to a container.
default GetLifecyclePolicyResponse	getLifecyclePolicy(GetLifecyclePolicyRequest getLifecyclePolicyRequest)	Retrieves the object lifecycle policy that is assigned to a container.
default GetMetricPolicyResponse	getMetricPolicy(Consumer<GetMetricPolicyRequest.Builder> getMetricPolicyRequest)	Returns the metric policy for the specified container.
default GetMetricPolicyResponse	getMetricPolicy(GetMetricPolicyRequest getMetricPolicyRequest)	Returns the metric policy for the specified container.
default ListContainersResponse	listContainers()	Lists the properties of all containers in AWS Elemental MediaStore.
default ListContainersResponse	listContainers(Consumer<ListContainersRequest.Builder> listContainersRequest)	Lists the properties of all containers in AWS Elemental MediaStore.
default ListContainersResponse	listContainers(ListContainersRequest listContainersRequest)	Lists the properties of all containers in AWS Elemental MediaStore.
default ListContainersIterable	listContainersPaginator()	This is a variant of listContainers(software.amazon.awssdk.services.mediastore.model.ListContainersRequest) operation.
default ListContainersIterable	listContainersPaginator(Consumer<ListContainersRequest.Builder> listContainersRequest)	This is a variant of listContainers(software.amazon.awssdk.services.mediastore.model.ListContainersRequest) operation.
default ListContainersIterable	listContainersPaginator(ListContainersRequest listContainersRequest)	This is a variant of listContainers(software.amazon.awssdk.services.mediastore.model.ListContainersRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Returns a list of the tags assigned to the specified container.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Returns a list of the tags assigned to the specified container.
default PutContainerPolicyResponse	putContainerPolicy(Consumer<PutContainerPolicyRequest.Builder> putContainerPolicyRequest)	Creates an access policy for the specified container to restrict the users and clients that can access it.
default PutContainerPolicyResponse	putContainerPolicy(PutContainerPolicyRequest putContainerPolicyRequest)	Creates an access policy for the specified container to restrict the users and clients that can access it.
default PutCorsPolicyResponse	putCorsPolicy(Consumer<PutCorsPolicyRequest.Builder> putCorsPolicyRequest)	Sets the cross-origin resource sharing (CORS) configuration on a container so that the container can service cross-origin requests.
default PutCorsPolicyResponse	putCorsPolicy(PutCorsPolicyRequest putCorsPolicyRequest)	Sets the cross-origin resource sharing (CORS) configuration on a container so that the container can service cross-origin requests.
default PutLifecyclePolicyResponse	putLifecyclePolicy(Consumer<PutLifecyclePolicyRequest.Builder> putLifecyclePolicyRequest)	Writes an object lifecycle policy to a container.
default PutLifecyclePolicyResponse	putLifecyclePolicy(PutLifecyclePolicyRequest putLifecyclePolicyRequest)	Writes an object lifecycle policy to a container.
default PutMetricPolicyResponse	putMetricPolicy(Consumer<PutMetricPolicyRequest.Builder> putMetricPolicyRequest)	The metric policy that you want to add to the container.
default PutMetricPolicyResponse	putMetricPolicy(PutMetricPolicyRequest putMetricPolicyRequest)	The metric policy that you want to add to the container.
default MediaStoreServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default StartAccessLoggingResponse	startAccessLogging(Consumer<StartAccessLoggingRequest.Builder> startAccessLoggingRequest)	Starts access logging on the specified container.
default StartAccessLoggingResponse	startAccessLogging(StartAccessLoggingRequest startAccessLoggingRequest)	Starts access logging on the specified container.
default StopAccessLoggingResponse	stopAccessLogging(Consumer<StopAccessLoggingRequest.Builder> stopAccessLoggingRequest)	Stops access logging on the specified container.
default StopAccessLoggingResponse	stopAccessLogging(StopAccessLoggingRequest stopAccessLoggingRequest)	Stops access logging on the specified container.
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Adds tags to the specified AWS Elemental MediaStore container.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Adds tags to the specified AWS Elemental MediaStore container.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes tags from the specified container.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes tags from the specified container.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

createContainer

default CreateContainerResponse createContainer(CreateContainerRequest createContainerRequest)
                                         throws ContainerInUseException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

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.

See Also:

• AWS API Documentation

createContainer

default CreateContainerResponse createContainer(Consumer<CreateContainerRequest.Builder> createContainerRequest)
                                         throws ContainerInUseException,
LimitExceededException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

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

This is a convenience which creates an instance of the CreateContainerRequest.Builder avoiding the need to create one manually via CreateContainerRequest.builder()

Parameters:

createContainerRequest - A Consumer that will call methods on CreateContainerRequest.Builder to create a request.

Returns:

Result of the CreateContainer operation returned by the service.

See Also:

• AWS API Documentation

deleteContainer

default DeleteContainerResponse deleteContainer(DeleteContainerRequest deleteContainerRequest)
                                         throws ContainerInUseException,
ContainerNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

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.

See Also:

• AWS API Documentation

deleteContainer

default DeleteContainerResponse deleteContainer(Consumer<DeleteContainerRequest.Builder> deleteContainerRequest)
                                         throws ContainerInUseException,
ContainerNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

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.

This is a convenience which creates an instance of the DeleteContainerRequest.Builder avoiding the need to create one manually via DeleteContainerRequest.builder()

Parameters:

deleteContainerRequest - A Consumer that will call methods on DeleteContainerRequest.Builder to create a request.

Returns:

Result of the DeleteContainer operation returned by the service.

See Also:

• AWS API Documentation

deleteContainerPolicy

default DeleteContainerPolicyResponse deleteContainerPolicy(DeleteContainerPolicyRequest deleteContainerPolicyRequest)
                                                     throws ContainerInUseException,
ContainerNotFoundException,
PolicyNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

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

Parameters:

deleteContainerPolicyRequest -

Returns:

Result of the DeleteContainerPolicy operation returned by the service.

See Also:

• AWS API Documentation

deleteContainerPolicy

default DeleteContainerPolicyResponse deleteContainerPolicy(Consumer<DeleteContainerPolicyRequest.Builder> deleteContainerPolicyRequest)
                                                     throws ContainerInUseException,
ContainerNotFoundException,
PolicyNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

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

This is a convenience which creates an instance of the DeleteContainerPolicyRequest.Builder avoiding the need to create one manually via DeleteContainerPolicyRequest.builder()

Parameters:

deleteContainerPolicyRequest - A Consumer that will call methods on DeleteContainerPolicyRequest.Builder to create a request.

Returns:

Result of the DeleteContainerPolicy operation returned by the service.

See Also:

• AWS API Documentation

deleteCorsPolicy

default DeleteCorsPolicyResponse deleteCorsPolicy(DeleteCorsPolicyRequest deleteCorsPolicyRequest)
                                           throws ContainerInUseException,
ContainerNotFoundException,
CorsPolicyNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

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.

See Also:

• AWS API Documentation

deleteCorsPolicy

default DeleteCorsPolicyResponse deleteCorsPolicy(Consumer<DeleteCorsPolicyRequest.Builder> deleteCorsPolicyRequest)
                                           throws ContainerInUseException,
ContainerNotFoundException,
CorsPolicyNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

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.

This is a convenience which creates an instance of the DeleteCorsPolicyRequest.Builder avoiding the need to create one manually via DeleteCorsPolicyRequest.builder()

Parameters:

deleteCorsPolicyRequest - A Consumer that will call methods on DeleteCorsPolicyRequest.Builder to create a request.

Returns:

Result of the DeleteCorsPolicy operation returned by the service.

See Also:

• AWS API Documentation

deleteLifecyclePolicy

default DeleteLifecyclePolicyResponse deleteLifecyclePolicy(DeleteLifecyclePolicyRequest deleteLifecyclePolicyRequest)
                                                     throws ContainerInUseException,
ContainerNotFoundException,
PolicyNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

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.

See Also:

• AWS API Documentation

deleteLifecyclePolicy

default DeleteLifecyclePolicyResponse deleteLifecyclePolicy(Consumer<DeleteLifecyclePolicyRequest.Builder> deleteLifecyclePolicyRequest)
                                                     throws ContainerInUseException,
ContainerNotFoundException,
PolicyNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

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

This is a convenience which creates an instance of the DeleteLifecyclePolicyRequest.Builder avoiding the need to create one manually via DeleteLifecyclePolicyRequest.builder()

Parameters:

deleteLifecyclePolicyRequest - A Consumer that will call methods on DeleteLifecyclePolicyRequest.Builder to create a request.

Returns:

Result of the DeleteLifecyclePolicy operation returned by the service.

See Also:

• AWS API Documentation

deleteMetricPolicy

default DeleteMetricPolicyResponse deleteMetricPolicy(DeleteMetricPolicyRequest deleteMetricPolicyRequest)
                                               throws ContainerInUseException,
ContainerNotFoundException,
PolicyNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

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.

See Also:

• AWS API Documentation

deleteMetricPolicy

default DeleteMetricPolicyResponse deleteMetricPolicy(Consumer<DeleteMetricPolicyRequest.Builder> deleteMetricPolicyRequest)
                                               throws ContainerInUseException,
ContainerNotFoundException,
PolicyNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

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.

This is a convenience which creates an instance of the DeleteMetricPolicyRequest.Builder avoiding the need to create one manually via DeleteMetricPolicyRequest.builder()

Parameters:

deleteMetricPolicyRequest - A Consumer that will call methods on DeleteMetricPolicyRequest.Builder to create a request.

Returns:

Result of the DeleteMetricPolicy operation returned by the service.

See Also:

• AWS API Documentation

describeContainer

default DescribeContainerResponse describeContainer(DescribeContainerRequest describeContainerRequest)
                                             throws ContainerNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

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.

See Also:

• AWS API Documentation

describeContainer

default DescribeContainerResponse describeContainer(Consumer<DescribeContainerRequest.Builder> describeContainerRequest)
                                             throws ContainerNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

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.

This is a convenience which creates an instance of the DescribeContainerRequest.Builder avoiding the need to create one manually via DescribeContainerRequest.builder()

Parameters:

describeContainerRequest - A Consumer that will call methods on DescribeContainerRequest.Builder to create a request.

Returns:

Result of the DescribeContainer operation returned by the service.

See Also:

• AWS API Documentation

getContainerPolicy

default GetContainerPolicyResponse getContainerPolicy(GetContainerPolicyRequest getContainerPolicyRequest)
                                               throws ContainerInUseException,
ContainerNotFoundException,
PolicyNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

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.

See Also:

• AWS API Documentation

getContainerPolicy

default GetContainerPolicyResponse getContainerPolicy(Consumer<GetContainerPolicyRequest.Builder> getContainerPolicyRequest)
                                               throws ContainerInUseException,
ContainerNotFoundException,
PolicyNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

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.

This is a convenience which creates an instance of the GetContainerPolicyRequest.Builder avoiding the need to create one manually via GetContainerPolicyRequest.builder()

Parameters:

getContainerPolicyRequest - A Consumer that will call methods on GetContainerPolicyRequest.Builder to create a request.

Returns:

Result of the GetContainerPolicy operation returned by the service.

See Also:

• AWS API Documentation

getCorsPolicy

default GetCorsPolicyResponse getCorsPolicy(GetCorsPolicyRequest getCorsPolicyRequest)
                                     throws ContainerInUseException,
ContainerNotFoundException,
CorsPolicyNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

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.

See Also:

• AWS API Documentation

getCorsPolicy

default GetCorsPolicyResponse getCorsPolicy(Consumer<GetCorsPolicyRequest.Builder> getCorsPolicyRequest)
                                     throws ContainerInUseException,
ContainerNotFoundException,
CorsPolicyNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

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.

This is a convenience which creates an instance of the GetCorsPolicyRequest.Builder avoiding the need to create one manually via GetCorsPolicyRequest.builder()

Parameters:

getCorsPolicyRequest - A Consumer that will call methods on GetCorsPolicyRequest.Builder to create a request.

Returns:

Result of the GetCorsPolicy operation returned by the service.

See Also:

• AWS API Documentation

getLifecyclePolicy

default GetLifecyclePolicyResponse getLifecyclePolicy(GetLifecyclePolicyRequest getLifecyclePolicyRequest)
                                               throws ContainerInUseException,
ContainerNotFoundException,
PolicyNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

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

Parameters:

getLifecyclePolicyRequest -

Returns:

Result of the GetLifecyclePolicy operation returned by the service.

See Also:

• AWS API Documentation

getLifecyclePolicy

default GetLifecyclePolicyResponse getLifecyclePolicy(Consumer<GetLifecyclePolicyRequest.Builder> getLifecyclePolicyRequest)
                                               throws ContainerInUseException,
ContainerNotFoundException,
PolicyNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

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

This is a convenience which creates an instance of the GetLifecyclePolicyRequest.Builder avoiding the need to create one manually via GetLifecyclePolicyRequest.builder()

Parameters:

getLifecyclePolicyRequest - A Consumer that will call methods on GetLifecyclePolicyRequest.Builder to create a request.

Returns:

Result of the GetLifecyclePolicy operation returned by the service.

See Also:

• AWS API Documentation

getMetricPolicy

default GetMetricPolicyResponse getMetricPolicy(GetMetricPolicyRequest getMetricPolicyRequest)
                                         throws ContainerNotFoundException,
PolicyNotFoundException,
ContainerInUseException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

Returns the metric policy for the specified container.

Parameters:

getMetricPolicyRequest -

Returns:

Result of the GetMetricPolicy operation returned by the service.

See Also:

• AWS API Documentation

getMetricPolicy

default GetMetricPolicyResponse getMetricPolicy(Consumer<GetMetricPolicyRequest.Builder> getMetricPolicyRequest)
                                         throws ContainerNotFoundException,
PolicyNotFoundException,
ContainerInUseException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

Returns the metric policy for the specified container.

This is a convenience which creates an instance of the GetMetricPolicyRequest.Builder avoiding the need to create one manually via GetMetricPolicyRequest.builder()

Parameters:

getMetricPolicyRequest - A Consumer that will call methods on GetMetricPolicyRequest.Builder to create a request.

Returns:

Result of the GetMetricPolicy operation returned by the service.

See Also:

• AWS API Documentation

listContainers

default ListContainersResponse listContainers(ListContainersRequest listContainersRequest)
                                       throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

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.

See Also:

• AWS API Documentation

listContainers

default ListContainersResponse listContainers(Consumer<ListContainersRequest.Builder> listContainersRequest)
                                       throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

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.

This is a convenience which creates an instance of the ListContainersRequest.Builder avoiding the need to create one manually via ListContainersRequest.builder()

Parameters:

listContainersRequest - A Consumer that will call methods on ListContainersRequest.Builder to create a request.

Returns:

Result of the ListContainers operation returned by the service.

See Also:

• AWS API Documentation

listContainers

default ListContainersResponse listContainers()
                                       throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

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.

Returns:

Result of the ListContainers operation returned by the service.

See Also:

• listContainers(ListContainersRequest)
• AWS API Documentation

listContainersPaginator

default ListContainersIterable listContainersPaginator()
                                                throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

This is a variant of listContainers(software.amazon.awssdk.services.mediastore.model.ListContainersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.mediastore.paginators.ListContainersIterable responses = client.listContainersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.mediastore.paginators.ListContainersIterable responses = client
             .listContainersPaginator(request);
     for (software.amazon.awssdk.services.mediastore.model.ListContainersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.mediastore.paginators.ListContainersIterable responses = client.listContainersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listContainers(software.amazon.awssdk.services.mediastore.model.ListContainersRequest) operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• listContainersPaginator(ListContainersRequest)
• AWS API Documentation

listContainersPaginator

default ListContainersIterable listContainersPaginator(ListContainersRequest listContainersRequest)
                                                throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

This is a variant of listContainers(software.amazon.awssdk.services.mediastore.model.ListContainersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.mediastore.paginators.ListContainersIterable responses = client.listContainersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.mediastore.paginators.ListContainersIterable responses = client
             .listContainersPaginator(request);
     for (software.amazon.awssdk.services.mediastore.model.ListContainersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.mediastore.paginators.ListContainersIterable responses = client.listContainersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listContainers(software.amazon.awssdk.services.mediastore.model.ListContainersRequest) operation.

Parameters:

listContainersRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listContainersPaginator

default ListContainersIterable listContainersPaginator(Consumer<ListContainersRequest.Builder> listContainersRequest)
                                                throws InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

This is a variant of listContainers(software.amazon.awssdk.services.mediastore.model.ListContainersRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.mediastore.paginators.ListContainersIterable responses = client.listContainersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.mediastore.paginators.ListContainersIterable responses = client
             .listContainersPaginator(request);
     for (software.amazon.awssdk.services.mediastore.model.ListContainersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.mediastore.paginators.ListContainersIterable responses = client.listContainersPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listContainers(software.amazon.awssdk.services.mediastore.model.ListContainersRequest) operation.

This is a convenience which creates an instance of the ListContainersRequest.Builder avoiding the need to create one manually via ListContainersRequest.builder()

Parameters:

listContainersRequest - A Consumer that will call methods on ListContainersRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws ContainerInUseException,
ContainerNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

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

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws ContainerInUseException,
ContainerNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

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

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

putContainerPolicy

default PutContainerPolicyResponse putContainerPolicy(PutContainerPolicyRequest putContainerPolicyRequest)
                                               throws ContainerNotFoundException,
ContainerInUseException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

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.

See Also:

• AWS API Documentation

putContainerPolicy

default PutContainerPolicyResponse putContainerPolicy(Consumer<PutContainerPolicyRequest.Builder> putContainerPolicyRequest)
                                               throws ContainerNotFoundException,
ContainerInUseException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

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.

This is a convenience which creates an instance of the PutContainerPolicyRequest.Builder avoiding the need to create one manually via PutContainerPolicyRequest.builder()

Parameters:

putContainerPolicyRequest - A Consumer that will call methods on PutContainerPolicyRequest.Builder to create a request.

Returns:

Result of the PutContainerPolicy operation returned by the service.

See Also:

• AWS API Documentation

putCorsPolicy

default PutCorsPolicyResponse putCorsPolicy(PutCorsPolicyRequest putCorsPolicyRequest)
                                     throws ContainerNotFoundException,
ContainerInUseException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

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.

See Also:

• AWS API Documentation

putCorsPolicy

default PutCorsPolicyResponse putCorsPolicy(Consumer<PutCorsPolicyRequest.Builder> putCorsPolicyRequest)
                                     throws ContainerNotFoundException,
ContainerInUseException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

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.

This is a convenience which creates an instance of the PutCorsPolicyRequest.Builder avoiding the need to create one manually via PutCorsPolicyRequest.builder()

Parameters:

putCorsPolicyRequest - A Consumer that will call methods on PutCorsPolicyRequest.Builder to create a request.

Returns:

Result of the PutCorsPolicy operation returned by the service.

See Also:

• AWS API Documentation

putLifecyclePolicy

default PutLifecyclePolicyResponse putLifecyclePolicy(PutLifecyclePolicyRequest putLifecyclePolicyRequest)
                                               throws ContainerInUseException,
ContainerNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

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.

See Also:

• AWS API Documentation

putLifecyclePolicy

default PutLifecyclePolicyResponse putLifecyclePolicy(Consumer<PutLifecyclePolicyRequest.Builder> putLifecyclePolicyRequest)
                                               throws ContainerInUseException,
ContainerNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

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.

This is a convenience which creates an instance of the PutLifecyclePolicyRequest.Builder avoiding the need to create one manually via PutLifecyclePolicyRequest.builder()

Parameters:

putLifecyclePolicyRequest - A Consumer that will call methods on PutLifecyclePolicyRequest.Builder to create a request.

Returns:

Result of the PutLifecyclePolicy operation returned by the service.

See Also:

• AWS API Documentation

putMetricPolicy

default PutMetricPolicyResponse putMetricPolicy(PutMetricPolicyRequest putMetricPolicyRequest)
                                         throws ContainerInUseException,
ContainerNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

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.

See Also:

• AWS API Documentation

putMetricPolicy

default PutMetricPolicyResponse putMetricPolicy(Consumer<PutMetricPolicyRequest.Builder> putMetricPolicyRequest)
                                         throws ContainerInUseException,
ContainerNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

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.

This is a convenience which creates an instance of the PutMetricPolicyRequest.Builder avoiding the need to create one manually via PutMetricPolicyRequest.builder()

Parameters:

putMetricPolicyRequest - A Consumer that will call methods on PutMetricPolicyRequest.Builder to create a request.

Returns:

Result of the PutMetricPolicy operation returned by the service.

See Also:

• AWS API Documentation

startAccessLogging

default StartAccessLoggingResponse startAccessLogging(StartAccessLoggingRequest startAccessLoggingRequest)
                                               throws ContainerInUseException,
ContainerNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

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.

See Also:

• AWS API Documentation

startAccessLogging

default StartAccessLoggingResponse startAccessLogging(Consumer<StartAccessLoggingRequest.Builder> startAccessLoggingRequest)
                                               throws ContainerInUseException,
ContainerNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

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.

This is a convenience which creates an instance of the StartAccessLoggingRequest.Builder avoiding the need to create one manually via StartAccessLoggingRequest.builder()

Parameters:

startAccessLoggingRequest - A Consumer that will call methods on StartAccessLoggingRequest.Builder to create a request.

Returns:

Result of the StartAccessLogging operation returned by the service.

See Also:

• AWS API Documentation

stopAccessLogging

default StopAccessLoggingResponse stopAccessLogging(StopAccessLoggingRequest stopAccessLoggingRequest)
                                             throws ContainerInUseException,
ContainerNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

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.

See Also:

• AWS API Documentation

stopAccessLogging

default StopAccessLoggingResponse stopAccessLogging(Consumer<StopAccessLoggingRequest.Builder> stopAccessLoggingRequest)
                                             throws ContainerInUseException,
ContainerNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

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.

This is a convenience which creates an instance of the StopAccessLoggingRequest.Builder avoiding the need to create one manually via StopAccessLoggingRequest.builder()

Parameters:

stopAccessLoggingRequest - A Consumer that will call methods on StopAccessLoggingRequest.Builder to create a request.

Returns:

Result of the StopAccessLogging operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws ContainerInUseException,
ContainerNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

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.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws ContainerInUseException,
ContainerNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

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.

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws ContainerInUseException,
ContainerNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

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.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws ContainerInUseException,
ContainerNotFoundException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
MediaStoreException

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

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

create

static MediaStoreClient create()

Create a MediaStoreClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static MediaStoreClientBuilder builder()

Create a builder that can be used to configure and create a MediaStoreClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default MediaStoreServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration